package yelp

// A SearchResult is returned from the Search API. It includes
// the region, the total number of results, and a list of matching businesses.
// The business objects returned by this query are shallow - they will not include
// deep results such as reviews.
type SearchResult struct {
	Region     Region      `json:"region"`     // Suggested bounds in a map to display results in
	Total      int         `json:"total"`      // Total number of business results
	Businesses []Business  `json:"businesses"` // The list of business entries (see Business)
	Error      ErrorStruct `json:"error"`
}

// Region provides the location of a business obtained from search.
type Region struct {
	Span   Span   // Span of suggested map bounds
	Center Center // Center position of map bounds
}

// Span provides the variance of the location from the region in the search result.
type Span struct {
	LatitudeDelta  float32 `json:"latitude_delta"`  // Latitude width of map bounds
	LongitudeDelta float32 `json:"longitude_delta"` // Longitude height of map bounds
}

// Center provides the coordinate where the business is most likely to be located.
type Center struct {
	Latitude  float32 // Latitude position of map bounds center
	Longitude float32 // Longitude position of map bounds center
}

// Deal defines a set of special offerings from the business.
type Deal struct {
	ID                     string       // Deal identifier
	Title                  string       // Deal title
	URL                    string       // Deal URL
	ImageURL               string       `json:"image_URL"`               // Deal image URL
	CurrencyCode           string       `json:"currency_code"`           // ISO_4217 Currency Code
	TimeStart              float32      `json:"time_start"`              // Deal start time (Unix timestamp)
	TimeEnd                float32      `json:"time_end"`                // Deal end time (optional: this field is present only if the Deal ends)
	IsPopular              bool         `json:"is_popular"`              // Whether the Deal is popular (optional: this field is present only if true)
	WhatYouGet             string       `json:"what_you_get"`            // Additional details for the Deal, separated by newlines
	ImportantRestrictions  string       `json:"Important_restrictions"`  // Important restrictions for the Deal, separated by newlines
	AdditionalRestrictions string       `json:"Additional_restrictions"` // Deal additional restrictions
	Options                []DealOption //Deal options

}

// DealOption provides options are optionally included on a deal.
type DealOption struct {
	Title                  string  // Deal option title
	PurchaseURL            string  `json:"Purchase_URL"` // Deal option URL for purchase
	Price                  float32 // Deal option price (in cents)
	FormattedPrice         string  `json:"Formatted_price"`          // Deal option price (formatted, e.g. "$6")
	OriginalPrice          float32 `json:"Original_price"`           // Deal option original price (in cents)
	FormattedOriginalPrice string  `json:"Formatted_original_price"` // Deal option original price (formatted, e.g. "$12")
	IsQuantityLimited      bool    `json:"Is_quantity_limited"`      // Whether the deal option is limited or unlimited
	RemainingCount         float32 `json:"Remaining_count"`          // The remaining deal options available for purchase (optional: this field is only present if the deal is limited)
}

// GiftCertificate defines optional data available on Businesses.
type GiftCertificate struct {
	ID             string                   // Gift certificate identifier
	URL            string                   // Gift certificate landing page URL
	ImageURL       string                   `json:"Image_URL"`       //	Gift certificate image URL
	CurrencyCode   string                   `json:"Currency_code"`   // ISO_4217 Currency Code
	UnusedBalances string                   `json:"Unused_balances"` // Whether unused balances are returned as cash or store credit
	Options        []GiftCertificateOptions //	Gift certificate options
}

// GiftCertificateOptions can define a set of pricing options for a gift certificate.
type GiftCertificateOptions struct {
	Price          float32 //	Gift certificate option price (in cents)
	FormattedPrice string  `json:"Formatted_price"` //	Gift certificate option price (formatted, e.g. "$50")
}

// Review data contains a list of user reviews for a given Business (when queried using the Business API).
type Review struct {
	ID                  string  // Review identifier
	Rating              float32 // Rating from 1-5
	RatingImageURL      string  `json:"Rating_image_URL"`       // URL to star rating image for this business (size = 84x17)
	RatingImageSmallURL string  `json:"Rating_image_small_URL"` // URL to small version of rating image for this business (size = 50x10)
	RatingImageLargeURL string  `json:"Rating_image_large_URL"` // URL to large version of rating image for this business (size = 166x30)
	Excerpt             string  // Review excerpt
	TimeCreated         float32 `json:"Time_created"` // Time created (Unix timestamp)
	User                User    // User who wrote the review
}

// User data is linked off of reviews.
type User struct {
	ID       string // User identifier
	ImageURL string `json:"Image_URL"` // User profile image URL
	Name     string // User name
}

// Coordinates data is used with location information.
type Coordinates struct {
	Latitude  float32 `json:"latitude"`  // Latitude of current location
	Longitude float32 `json:"longitude"` // Longitude of current location
}

// Location information defines the location of a given business.
type Location struct {
	Address1       string   `json:"address1"`        // Address for this business. Only includes address fields.
	Address2       string   `json:"address2"`        // Address for this business. Only includes address fields.
	Address3       string   `json:"address3"`        // Address for this business. Only includes address fields.
	City           string   `json:"city"`            // City for this business
	ZipCode        string   `json:"zip_code"`        // Zip-code for this business
	Country        string   `json:"country"`         // Country for this business
	State          string   `json:"state"`           // State for this business
	DisplayAddress []string `json:"display_address"` // Display address for the business.
	CrossStreets   string   `json:"cross_streets"`   // Cross streets for this business
}

// Hours provides the open data for this business
type Hours struct {
	Open      []Open `json:"open"`
	HoursType string `json:"hours_type"`
	IsOpenNow bool   `json:"is_open_now"`
}

// Open provides the opening time for this business
type Open struct {
	IsOvernight bool   `json:"is_overnight"`
	Start       string `json:"start"`
	End         string `json:"end"`
	Day         int    `json:"day"`
}

// Category provides the opening time for this business
type Category struct {
	Alias string `json:"alias"`
	Title string `json:"title"`
}

// ErrorStruct provides errors returned by yelp
type ErrorStruct struct {
	Code        string `json:"code"`
	Description string `json:"description"`
}

// Business information is returned in full from the business API, or shallow from the search API.
type Business struct {
	ID           string      `json:"id"`            // Yelp ID for this business
	Name         string      `json:"name"`          // Name of this business
	ImageURL     string      `json:"image_url"`     // URL of photo for this business
	IsClaimed    bool        `json:"is_claimed"`    // Whether business has been claimed by a business owner
	IsClosed     bool        `json:"is_closed"`     // Whether business has been (permanently) closed
	URL          string      `json:"url"`           // URL for business page on Yelp
	Phone        string      `json:"phone"`         // Phone number for this business with international dialing code (e.g. +442079460000)
	DisplayPhone string      `json:"display_phone"` // Phone number for this business formatted for display
	ReviewCount  int         `json:"review_count"`  // Number of reviews for this business
	Categories   []Category  `json:"categories"`    // Provides a list of category name, alias pairs that this business is associated with. The alias is provided so you can search with the category_filter.
	Rating       float32     `json:"rating"`        // Rating for this business (value ranges from 1, 1.5, ... 4.5, 5)
	Location     Location    `json:"location"`      // Location data for this business
	Coordinates  Coordinates `json:"coordinates"`   // Address for this business formatted for display. Includes all address fields, cross streets and city, state_code, etc.
	Photos       []string    `json:"photos"`        // Photos for this business
	Price        string      `json:"price"`
	Hours        []Hours     `json:"hours"`
	Transactions []string    `json:"transactions"`
	Distance     float32     `json:"distance"` // Distance that business is from search location in meters, if a latitude/longitude is specified.
	Error        ErrorStruct `json:"error"`

	//	MobileURL         string            `json:"Mobile_URL"` // URL for mobile business page on Yelp

	// RatingImgURL      string `json:"Rating_img_URL"`       // URL to star rating image for this business (size = 84x17)
	// RatingImgURLSmall string `json:"Rating_img_URL_small"` // URL to small version of rating image for this business (size = 50x10)
	// RatingImgURLLarge string `json:"Rating_img_URL_large"` // URL to large version of rating image for this business (size = 166x30)
	// SnippetText       string `json:"Snippet_text"`         // Snippet text associated with this business
	// SnippetImageURL   string `json:"Snippet_image_URL"`    // URL of snippet image associated with this business

	// MenuProvider     string            `json:"Menu_provider"`     // Provider of the menu for this business
	// MenuDateUpdated  float32           `json:"Menu_date_updated"` // Last time this menu was updated on Yelp (Unix timestamp)
	// Deals            []Deal            // Deal info for this business (optional: this field is present only if there’s a Deal)
	// GiftCertificates []GiftCertificate `json:"Gift_certificates"` // Gift certificate info for this business (optional: this field is present only if there are gift certificates available)
	// Reviews          []Review          // Contains one review associated with business
}