walmart

type Category struct {
	ID       string   `json:"id" kit:"id"`
	Name     string   `json:"name"`
	Parent   string   `json:"parent,omitempty"`                                               // parent category name (from the trail)
	ParentID string   `json:"parent_id,omitempty" table:"-" kit:"link,kind=walmart/category"` // edge up to the parent node
	Children []string `json:"children,omitempty" table:"-" kit:"link,kind=walmart/category"`  // edges down to the child nodes
	Trail    []string `json:"trail,omitempty" table:"-"`                                      // the full ancestor path, root first, leaf last
	URL      string   `json:"url"`
}

type Client struct {
	HTTP      *http.Client
	BaseURL   string
	UserAgent string
	Delay     time.Duration
	Retries   int

	// SuggestURL is the typeahead endpoint. It defaults to the public host; tests
	// point it at an httptest server.
	SuggestURL string
	// contains filtered or unexported fields
}

type Config struct {
	UserAgent string

	// Zip is the ZIP context for the store locator and the default-store price on
	// the API path. Empty leaves it to Walmart's default store.
	Zip string

	// The affiliate credentials enable the API fallback for the walled surfaces.
	// ConsumerID with one of PrivateKey or PrivateKeyFile turns it on; empty
	// leaves the fallback off, and the walled commands then report the bot wall
	// rather than guessing.
	ConsumerID     string
	PrivateKey     string // PEM contents
	PrivateKeyFile string // path to a PEM file, used when PrivateKey is empty
	KeyVersion     string
	PublisherID    string

	// Delay is the minimum gap between requests. Zero means no pacing.
	Delay   time.Duration
	Retries int
	Timeout time.Duration

	// BaseURL is the site root. Empty uses the public site; tests point it at an
	// httptest server.
	BaseURL string

	// CacheDir is where responses are cached. Empty disables the cache, as does
	// NoCache.
	CacheDir string
	CacheTTL time.Duration
	NoCache  bool
	// Refresh fetches fresh copies and rewrites the cache, ignoring any hit.
	Refresh bool
}

type Deal struct {
	ID       string  `json:"id" kit:"id"`
	Title    string  `json:"title,omitempty" table:",truncate"`
	Brand    string  `json:"brand,omitempty"`
	Price    float64 `json:"price,omitempty"`
	Was      float64 `json:"was,omitempty"`  // price before the markdown
	Save     float64 `json:"save,omitempty"` // was minus price
	Currency string  `json:"currency,omitempty"`
	Offer    string  `json:"offer,omitempty"` // the offer type, e.g. "Rollback" or "Clearance"
	Rating   float64 `json:"rating,omitempty"`
	Reviews  int     `json:"reviews,omitempty"`
	Image    string  `json:"image,omitempty" table:",truncate"`
	URL      string  `json:"url"`
	Item     string  `json:"item,omitempty" table:"-" kit:"link,kind=walmart/product"` // edge to the full product
}

type Domain struct{}

type Listing struct {
	ID           string  `json:"id" kit:"id"`
	Title        string  `json:"title,omitempty" table:",truncate"`
	Brand        string  `json:"brand,omitempty"`
	Price        float64 `json:"price,omitempty"`
	Currency     string  `json:"currency,omitempty"`
	Was          float64 `json:"was,omitempty"` // strikethrough / was price
	Seller       string  `json:"seller,omitempty"`
	Rating       float64 `json:"rating,omitempty"`  // average star rating
	Reviews      int     `json:"reviews,omitempty"` // review count
	Availability string  `json:"availability,omitempty"`
	Sponsored    bool    `json:"sponsored,omitempty"` // an ad tile rather than an organic result
	Thumbnail    string  `json:"thumbnail,omitempty" table:",truncate"`
	URL          string  `json:"url"`
	Item         string  `json:"item,omitempty" table:"-" kit:"link,kind=walmart/product"` // edge to the full product
}

type Product struct {
	ID           string   `json:"id" kit:"id"`
	Name         string   `json:"name,omitempty" table:",truncate"`
	Brand        string   `json:"brand,omitempty"`
	Model        string   `json:"model,omitempty"`
	UPC          string   `json:"upc,omitempty"`
	Price        float64  `json:"price,omitempty"`
	Currency     string   `json:"currency,omitempty"`
	Was          float64  `json:"was,omitempty"`  // was price, when the item is marked down
	List         float64  `json:"list,omitempty"` // manufacturer list price / MSRP
	Availability string   `json:"availability,omitempty"`
	Seller       string   `json:"seller,omitempty"`
	Rating       float64  `json:"rating,omitempty"`
	Reviews      int      `json:"reviews,omitempty"`
	Category     string   `json:"category,omitempty"`                                               // the leaf department name
	CategoryID   string   `json:"category_id,omitempty" table:"-" kit:"link,kind=walmart/category"` // edge to the leaf category
	Trail        []string `json:"trail,omitempty" table:"-"`                                        // the full department path, root first, leaf last
	Description  string   `json:"description,omitempty" table:",truncate"`
	Image        string   `json:"image,omitempty" table:",truncate"`
	Images       []string `json:"images,omitempty" table:"-"`                                   // the photo gallery, when more than one is listed
	Variants     []string `json:"variants,omitempty" table:"-" kit:"link,kind=walmart/product"` // edges to colour/size/configuration siblings
	URL          string   `json:"url"`
}

type Ref struct {
	Input string `json:"input"`
	Kind  string `json:"kind"`
	ID    string `json:"id"`
	URL   string `json:"url"`
}

type Store struct {
	ID       string  `json:"id" kit:"id"` // store number
	Name     string  `json:"name,omitempty"`
	Address  string  `json:"address,omitempty"`
	City     string  `json:"city,omitempty"`
	State    string  `json:"state,omitempty"`
	Zip      string  `json:"zip,omitempty"`
	Phone    string  `json:"phone,omitempty"`
	Lat      float64 `json:"lat,omitempty"`
	Lon      float64 `json:"lon,omitempty"`
	Distance float64 `json:"distance,omitempty"` // miles from the queried ZIP, on store find
	Hours    string  `json:"hours,omitempty"`
	URL      string  `json:"url"`
}

type Suggestion struct {
	Query string `json:"query"`           // the prefix that was queried
	Term  string `json:"term" kit:"id"`   // a suggested completion
	Image string `json:"image,omitempty"` // a thumbnail the typeahead pairs with some terms
}