amiibo

type Amiibo interface {

	// GetAvailable returns the Nintendo Amiibo product availability status.
	//
	// GetAvailable is calculated by evaluating the Nintendo Amiibo products release date is
	// before the current timestamp.
	GetAvailable() bool

	// GetID returns the Nintendo Amiibo products hash key ID.
	GetID() string

	// GetLanguage returns the Nintendo Amiibo products language identifier.
	GetLanguage() language.Tag

	// GetMD5 returns the Nintendo Amiibo products encoded MD5 hash sequence as well as the generated bytes.
	//
	// GetMD5 returns an additional error if the byte sequence cannot be generated or if the
	// MD5 hash cannot be produced.
	GetMD5() (string, []byte, error)

	// GetName returns the Nintendo Amiibo product name.
	//
	// GetName can contain unicode.
	GetName() string

	// GetNameAlternative returns the Nintendo Amiibo products alternative name.
	//
	// GetNameAlternative can contain unicode.
	GetNameAlternative() string

	// GetPrice returns the Nintendo Amiibo products retail price.
	//
	// GetPrice can contain unicode.
	GetPrice() string

	// GetReleaseDate returns the Nintendo Amiibo products retail release date as a formatted timestamp.
	GetReleaseDate() time.Time

	// GetSeries returns the series the Nintendo Amiibo product is affiliated with.
	//
	// GetSeries can contain unicode.
	GetSeries() string

	// GetURL return the direct URL to the Nintendo Amiibo product page.
	GetURL() string
}

type ENGAmiibo struct {

	// Affiliation is the series of Nintendo Amiibo products the item is associated with.
	Affiliation string `json:"affiliation"`

	// Available is the Nintendo Amiibo availability status.
	Availiable bool `json:"availiable"`

	// BoxImageURL is the direct URL to the Nintendo Amiibo product box.
	BoxImageURL string `json:"box_image_url"`

	// Description is the verbose description for the Nintendo Amiibo product.
	Description string `json:"description"`

	// DescriptionAlternative is the alternative description for the Nintendo Amiibo product.
	DescriptionAlternative string `json:"description_alternative"`

	// Path is the relative path to the Nintendo Amiibo product details.
	DetailsPath string `json:"details_path"`

	// DetailsURL is the direct URL to the Nintendo Amiibo product page.
	DetailsURL string `json:"details_url"`

	// Epoch is the release date for the Nintendo Amiibo product in seconds.
	Epoch int64 `json:"epoch"`

	// FigureImageURL is the direct URL to the Nintendo Amiibo figurine image.
	FigureImageURL string `json:"figure_image_url"`

	// Franchise is the name of the series the Nintendo Amiibo product is affiliated with.
	Franchise string `json:"franchise"`

	// GameID is the ID associated with the Nintendo software the Nintendo Amiibo product is associated with.
	GameID string `json:"game_id"`

	// Hex is the hexidecimal code associated with the Nintendo Amiibo product.
	Hex string `json:"hex"`

	// ID is the fully qualified ID for the Nintendo Amiibo product given by Nintendo of America.
	ID string `json:"id"`

	// LastModified is the formatted timestamp when the dataset was modified by Nintendo of America.
	LastModified time.Time `json:"last_modified"`

	// Name is the official name of the Nintendo Amiibo product.
	//
	// Name can contain unicode.
	Name string `json:"name"`

	// NameAlternative is the alternative name given to the Nintendo Amiibo product.
	//
	// NameAlternative can contain unicode.
	NameAlternative string `json:"name_alternative"`

	// Path is the relative path to the Nintendo Amiibo product details.
	Path string `json:"path"`

	// Price is the price of the Nintendo Amiibo product in USD.
	//
	// Price can be empty.
	Price string `json:"price"`

	// Producer is the company affiliation of the Nintendo Amiibo product.
	Producer string `json:"producer"`

	// Product is the product classification of the Nintendo Amiibo item.
	Product string `json:"product"`

	// ProductAlternative is the alternative classification for the Nintendo Amiibo product.
	ProductAlternative string `json:"product_alternative"`

	// ProductImageURL is the direct URL to the Nintendo Amiibo product image.
	ProductImageURL string `json:"product_image_url"`

	// ProductPage is the relative nintendo.com URL to the Nintendo Amiibo product page.
	ProductPage string `json:"product_page"`

	// ReleaseDate is the formatted timestamp of the Nintendo Amiibo products release date.
	ReleaseDate time.Time `json:"release_date"`

	// Series is the defined series of products that the Nintendo Amiibo product is group or affiliated with.
	Series string `json:"series"`

	// Title is the title for the Nintendo Amiibo product.
	Title string `json:"title"`

	// TitleAternative is the alternative title for the Nintendo Amiibo product.
	//
	// TitleAlternative can contain unicode.
	TitleAlternative string `json:"title_alternative"`

	// UPC is the universal product code for the Nintendo Amiibo product.
	UPC string `json:"upc"`

	// URL is the direct URL to the Nintendo Amiibo product page.
	URL string `json:"url"`

	// UUID is the UUID for the product given by Nintendo.
	UUID uuid.UUID `json:"uuid"`
}

type ENGAmiiboMap (map[string]ENGAmiibo)

type ENGChart struct {

	// AmiiboList is a collection of Nintendo Amiibo product information.
	AmiiboList []ENGChartAmiibo `json:"amiiboList"`

	// GameList is a collection of Nintendo Amiibo supported games.
	GameList []ENGChartGame `json:"gameList"`

	// Items is a collection of additional Nintendo Amiibo product information.
	Items []ENGChartItem `json:"items"`
}

type ENGChartAmiibo struct {

	// ID is the Nintendo Amiibo UUID.
	ID string `json:"id"`

	// Image is the relative path to the Nintendo Amiibo product image.
	Image string `json:"image"`

	// IsRelatedTo is the series or brand the Nintendo Amiibo product is related to.
	IsRelatedTo string `json:"isRelatedTo"`

	// IsReleased is the availability status of the Nintendo Amiibo product.
	IsReleased string `json:"isReleased"`

	// Name is the unformatted name of the Nintendo Amiibo product.
	Name string `json:"name"`

	// ReleaseDateMask is the YYYY-MM-DD timestamp when the Nintendo Amiibo product is or will be released.
	ReleaseDateMask string `json:"releaseDateMask"`

	// TagID is the ID assigned by Nintendo.
	TagID string `json:"tagid"`

	// Type is the Nintendo Amiibo product type.
	Type string `json:"type"`

	// URL is the relative path to the Nintendo Amiibo product page.
	URL string `json:"url"`
}

type ENGChartGame struct {

	// ID is the Nintendo game UUID.
	ID string `json:"id"`

	// Image is the relative path to the Nintendo game product image.
	Image string `json:"image"`

	// IsReleased is the availability status of the Nintendo game product.
	IsReleased string `json:"isReleased"`

	// Name is the unformatted name of the Nintendo game.
	Name string `json:"name"`

	// Path is the relative path to the Nintendo game product page.
	Path string `json:"path"`

	// ReleaseDateMask is the YYYY-MM-DD timestamp when the Nintendo game is or will be released.
	ReleaseDateMask string `json:"releaseDateMask"`

	// Type is the Nintendo product type.
	Type string `json:"type"`

	// URL is the relative path to the game page that supports a Nintendo Amiibo product.
	URL string `json:"url"`
}

type ENGChartItem struct {

	// Description is the Nintendo Amiibo item product description.
	Description string `json:"description"`

	// LastModified is the Nintendo Amiibo item product release date in milliseconds.
	LastModified int64 `json:"lastModified"`

	// Path is the relative path to the Nintendo Amiibo item product page.
	Path string `json:"path"`

	// Title is the unformatted name of the Nintendo Amiibo item product.
	Title string `json:"title"`

	// URL is the relative path to the Nintendo Amiibo item page.
	URL string `json:"url"`
}

type ENGGame struct {

	// Available is the Nintendo game availability status.
	Available bool `json:"available"`

	// Description is the verbose description for the Nintendo game product.
	Description string `json:"description"`

	// LastModified is the formatted timestamp when the dataset was modified by Nintendo of America.
	LastModified time.Time `json:"last_modified"`

	// Name is the official name of the Nintendo game product.
	//
	// Name can contain unicode.
	Name string `json:"name"`

	// Path is the relative path to the Nintendo game product details.
	Path string `json:"path"`

	// Product is the product classification of the Nintendo software item.
	Product string `json:"product"`

	// ProductImageURL is the direct URL to the Nintendo software product image.
	ProductImageURL string `json:"product_image_url"`

	// ReleaseDate is the formatted timestamp of the Nintendo software release date.
	ReleaseDate time.Time `json:"release_date"`

	// Title is the title for the Nintendo Amiibo product.
	Title string `json:"title"`

	// URL is the direct URL to the Nintendo Amiibo software page.
	URL string `json:"url"`

	// UUID is the UUID for the product given by Nintendo.
	UUID uuid.UUID `json:"uuid"`
}

type ENGGameMap (map[string]ENGGame)

type ENGLineup struct {

	// AmiiboList is a collection of Nintendo Amiibo products containing their product information.
	AmiiboList []ENGLineupAmiibo `json:"amiiboList"`

	// ComponentPath is the relative path to the Nintendo resource file.
	ComponentPath string `json:"componentPath"`

	// Items is a collection of metadata related to Nintendo Amiibo products.
	Items []ENGLineupItem `json:"items"`
}

type ENGLineupAmiibo struct {

	// AmiiboName is the name of the Nintendo Amiibo product.
	//
	// AmiiboName can contain special characters that require filtering.
	AmiiboName string `json:"amiiboName"`

	// AmiiboPage is the relative URL to the Nintendo Amiibo product details page.
	//
	// AmiiboPage requires nintendo.com to be prepended to the AmiiboPage.
	AmiiboPage string `json:"amiiboPage"`

	// BoxArtURL is the relative URL to the Nintendo Amiibo box image page.
	//
	// BoxArtURL requires nintendo.com to be prepended to the URL.
	BoxArtURL string `json:"boxArtUrl"`

	// DetailsPath is the relative path to the Nintendo Amiibo product information page.
	DetailsPath string `json:"detailsPath"`

	// DetailsURL is the relative URL to the Nintendo Amiibo product information page.
	//
	// DetailsURL requires nintendo.com to be prepended to the URL.
	DetailsURL string `json:"detailsUrl"`

	// FigureURL is the relative URL to the Nintendo Amiibo product image.
	//
	// FigureURL requires nintendo.com to be prepended to the FigureURL.
	FigureURL string `json:"figureUrl"`

	// Franchise is the Nintendo or third-party product the Nintendo Amiibo product is affiliated with.
	//
	// Franchise is often null.
	Franchise string `json:"franchise"`

	// GameCode is the ID for the Nintendo game that the Nintendo Amiibo product is affiliated with.
	GameCode string `json:"gameCode"`

	// HexCode is the hexidecimal code for the Nintendo Amiibo product.
	HexCode string `json:"hexCode"`

	// OverviewDescription is the verbose Nintendo Amiibo product summary.
	//
	// OverviewDescription contains HTML tags and requires filtering.
	OverviewDescription string `json:"overviewDescription"`

	// Price is the price of the Nintendo Amiibo product in USD.
	//
	// Price need to be converted to a float.
	Price string `json:"price"`

	// PresentedBy is the namespace of the affiliated partner for the Nintendo Amiibo product.
	PresentedBy string `json:"presentedBy"`

	// ReleaseDateMask is the DD-MM-YYYY timestamp for the Nintendo Amiibo product release date.
	ReleaseDateMask string `json:"releaseDateMask"`

	// Series is the Nintendo product series the Nintendo Amiibo product is affiliated with.
	Series string `json:"series"`

	// Slug is the formatted namespace of the Nintendo Amiibo product.
	Slug string `json:"slug"`

	// Type is the Nintendo Amiibo product classification type.
	Type string `json:"type"`

	// UnixTimestamp is the Nintendo Amiibo product release date in milliseconds.
	UnixTimestamp int64 `json:"unixTimestamp"`

	// UPC is the universal product code for the Nintendo Amiibo product.
	UPC string `json:"upc"`
}

type ENGLineupItem struct {

	// Description is the verbose Nintendo Amiibo product summary.
	//
	// Description is often a null field.
	Description string `json:"description"`

	// LastModified is the Nintendo Amiibo product release date in milliseconds.
	LastModified int64 `json:"lastModified"`

	// Path is the relative path to the Nintendo Amiibo product information page according to the nintendo.com CDN.
	Path string `json:"path"`

	// Title is the name of the Nintendo Amiibo product.
	//
	// Title can contain special characters that require filtering.
	Title string `json:"title"`

	// URL is the relative path URL to the Nintendo Amiibo product information page.
	//
	// URL requires nintendo.com to be prepended to the URL.
	URL string `json:"url"`
}

type JPNAmiibo struct {
	Chart bool `json:"chart"`

	// ID is the fully qualified ID for the Nintendo Amiibo product given by Nintendo Japan.
	ID string `json:"id"`

	// Large indicates the whether the Nintendo Amiibo product is considered a large scale item.
	Large bool `json:"large"`

	// Limited indicates the whether the Nintendo Amiibo product is a limited release.
	Limited bool `json:"limited"`

	// Name is the official name of the Nintendo Amiibo product.
	//
	// Name contains Japanese Hiragana.
	Name string `json:"name"`

	// NameAlternative is the alternative name given to the Nintendo Amiibo product.
	//
	// NameAlternative contains Japanese Hiragana.
	NameAlternative string `json:"name_alternative"`

	// New indicates the whether the Nintendo Amiibo product is a new release.
	New bool `json:"new"`

	// Price is the price of the Nintendo Amiibo product in JPY.
	//
	// Price can be empty.
	Price string `json:"price"`

	Priority int64 `json:"priority"`

	// ReleaseDate is the formatted timestamp of the Nintendo Amiibo products release date.
	ReleaseDate time.Time `json:"release_date"`

	// ReleaseDateAlternative is the Japanese formatted Nintendo Amiibo product release date.
	ReleaseDateAlternative time.Time `json:"release_data_alternative"`

	// Series is the defined series of products that the Nintendo Amiibo product is group or affiliated with.
	Series string `json:"series"`

	// Software is a collection of Nintendo software products the Nintendo Amiibo is compatible with.
	Software JPNAmiiboSoftwareMap `json:"software"`

	// URL is the direct URL to the Nintendo Amiibo product page.
	URL string `json:"url"`
}

type JPNAmiiboComing struct {
	Description            string
	DetailsPath            string
	DetailsURL             string
	Label                  string
	Name                   string
	NameAlternative        string
	Price                  string
	ReleaseDate            time.Time
	ReleaseDateAlternative string
	Series                 string
	Title                  string
	URL                    string
}

type JPNAmiiboMap (map[string]JPNAmiibo)

type JPNAmiiboSoftware struct {
	// Description is the verbose description for the Nintendo software product.
	Description string `json:"description"`
	// Digital indicates the whether the Nintendo software product is a digital only release.
	Digital bool `json:"digital"`
	// ID is the fully qualified ID for the Nintendo software product given by Nintendo Japan.
	ID string `json:"id"`
	// Name is the official name of the Nintendo software product.
	//
	// Name contains Japanese Hiragana.
	Name string `json:"name"`
	// URL is the direct URL to the Nintendo software product page.
	URL string `json:"url"`
}

type JPNAmiiboSoftwareMap (map[string]JPNAmiiboSoftware)

type JPNChart struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"items"`

	// Items is a collection of Nintendo Amiibo product information.
	Items []JPNChartItem `xml:"item"`
}

type JPNChartItem struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"item"`

	// Code is the ID code for the Nintendo product.
	Code string `xml:"code"`

	// Name is the name of the Nintendo product in Japanese Hiragana.
	Name string `xml:"name"`

	// Series is the Japanese Hiragana for the Nintendo product that the Nintendo Amiibo product is affiliated with.
	//
	// Series will need to be translated from Japanese to English.
	Series string `xml:"series"`

	// Softwares is a collection of metadata that the Nintendo Amiibo product integrates with.
	Softwares []JPNChartItemSoftware `xml:"softwares>software"`
}

type JPNChartItemSoftware struct {

	// Code is the ID code for the Nintendo product.
	Code string `xml:"code"`

	// Name is the name of the Nintendo product in Japanese Hiragana.
	Name string `xml:"name"`

	// More is the verbose description for the Nintendo Amiibo chart item.
	More string `xml:"more"`

	// Pickup is a provided property with an unclear purpose.
	Pickup int64 `xml:"pickup"`

	// ReadWrite is a provided property with an unclear purpose.
	ReadWrite string `xml:"readwrite"`
}

type JPNChartSoftware struct {
	XMLName xml.Name `xml:"items"`

	Items []JPNChartSoftwareItem `xml:"item"`
}

type JPNChartSoftwareItem struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"item"`

	// Blank is the direct URL to the Nintendo software information.
	Blank string `xml:"blank"`

	// Chart is a integer representation of a boolean.
	//
	// Chart relates to the occurrence of the Nintendo Amiibo product in the chart XML.
	Chart int `xml:"chart"`

	// Chartseries is the Japanese Hiragana for the Nintendo hardware system that the software is supported for.
	//
	// Chartseries will need to be translated from Japanese to English.
	Chartseries string `xml:"chartseries"`

	// Code is the ID code for the Nintendo product.
	Code string `xml:"code"`

	// Date is the YYYYMMDD expression of the Nintendo Amiibo product release date.
	Date string `xml:"date"`

	// DisplayDate is the Japanese Hiragana expression of the Nintedo Amiibo product release date.
	//
	// DisplayDate currently (2019年3月7日発売) has a typo on the nintendo.co.jp and exists
	// as dispalydate.
	DisplayDate string `xml:"dispalydate"`

	Icon int `xml:"icon"`

	// Info is the verbose description of the Nintendo software product in Japanese Hiragana.
	Info string `xml:"info"`

	// Name is the name of the Nintendo product in Japanese Hiragana.
	Name string `xml:"name"`

	// NameAlternative is the alternative name given to the Nintendo Amiibo product.
	//
	// NameAlternative contains Japanese Hiragana.
	NameKana string `xml:"nameKana"`

	// New is a integer representation of a boolean.
	//
	// New relates to the newness of the Nintendo software product.
	New int `xml:"new"`

	// Price is the price of the Nintendo Amiibo product in Japanese Yen.
	Price string `xml:"price"`

	// Priority is the numerical rank of the Nintendo Amiibo product.
	Priority string `xml:"priority"`

	// Series is the Japanese Hiragana for the Nintendo hardware system that the software is supported for.
	//
	// Series will need to be translated from Japanese to English.
	Series string `xml:"series"`

	// SoftOption is the Japanese Hiragana for the Nintendo hardware system that the software is supported for.
	//
	// SoftOption will need to be translated from Japanese to English.
	SoftOption string `xml:"softoption"`

	// Subname is the alternative description for the Nintendo software product.
	Subname string `xml:"subname"`
}

type JPNLineup struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"items"`

	// Item is a collection of Nintendo Amiibo products containing their product information in Japanese.
	Items []JPNLineupItem `xml:"item"`

	// SeriesItem is a collection of Nintendo Amiibo product auxiliary information.
	SeriesItems []JPNLineupSeriesItem `xml:"series_item"`
}

type JPNLineupComing struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"data"`

	// Items is a collection of Nintendo Amiibo product information.
	Items []JPNLineupComingItem `xml:"items>item"`
}

type JPNLineupComingItem struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"item"`

	// AmiiboLabel is the label for the Nintendo Amiibo product.
	AmiiboLabel string `xml:"amiibo_label"`

	// AmiiboLink is the URL for the Nintendo Amiibo product.
	AmiiboLink string `xml:"amiibo_link"`

	// AmiiboSeries is the Japanese Hiragana for the Nintendo product the Amiibo is affiliated with.
	AmiiboSeries string `xml:"amiibo_series"`

	// D is the YYYY-MM-DD datestamp for the Nintendo Amiibo product.
	D string `xml:"d"`

	// Link is the URL to the Nintendo Amiibo product.
	Link string `xml:"link"`

	// LinkTarget is the relative URL to the Nintendo Amiibo product.
	LinkTarget string `xml:"link_target"`

	// Memo is the verbose title for the Nintendo Amiibo product.
	Memo string `xml:"memo"`

	// Price is the price of the Nintendo Amiibo in Japanese Hiragana.
	Price string `xml:"price"`

	// ReleaseDateStr is the datestamp for the Nintendo Amiibo product release date in Japanese Hiragana.
	ReleaseDateStr string `xml:"release_date_str"`

	// ThumbVariation is the alternative namespace for the Nintendo Amiibo product.
	ThumbVariation string `xml:"thumb_variation"`

	// Title is the Japanese title in either Hiragana or Kanji for Nintendo Amiibo product.
	Title string `xml:"title"`

	// TitleRuby is the Japanese Hiragana for the Nintendo Amiibo product.
	TitleRuby string `xml:"title_ruby"`
}

type JPNLineupItem struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"item"`

	// BigSize is a integer representation of a boolean.
	//
	// BigSize relates to the scale of the Nintendo Amiibo product.
	BigSize int `xml:"bigsize"`

	// Chart is a integer representation of a boolean.
	//
	// Chart relates to the occurrence of the Nintendo Amiibo product in the chart XML.
	Chart int64 `xml:"chart"`

	// Code is the English ID for the Nintendo Amiibo product from the Japanese CDN.
	Code string `xml:"code"`

	// Date is the YYYYMMDD expression of the Nintendo Amiibo product release date.
	Date string `xml:"date"`

	// DisplayDate is the Japanese Hiragana expression of the Nintedo Amiibo product release date.
	//
	// DisplayDate currently (5/07/2020 (DD-MM-YYYY)) has a typo on the nintendo.co.jp and exists
	// as dispalydate.
	DisplayDate string `xml:"displayDate"`

	// Limited is a integer representation of a boolean.
	//
	// Limited relates to the rareness of the Nintendo Amiibo product.
	Limited int `xml:"limited"`

	// Name is the name of the Nintendo product in Japanese Hiragana.
	Name string `xml:"name"`

	// NameKana is the name of the Nintendo Amiibo product in Japanese Hiragana.
	NameKana string `xml:"nameKana"`

	// New is a integer representation of a boolean.
	//
	// New relates to the newness of the Nintendo Amiibo product.
	New int `xml:"new"`

	// Price is the price of the Nintendo Amiibo product in Japanese Yen.
	Price string `xml:"price"`

	// Priority is the numerical rank of the Nintendo Amiibo product.
	Priority int64 `xml:"priority"`

	// Series is the Japanese Hiragana for the Nintendo product that the Nintendo Amiibo product is affiliated with.
	//
	// Series will need to be translated from Japanese to English.
	Series string `xml:"series"`
}

type JPNLineupSeriesItem struct {

	// XMLName is the xml node.
	XMLName xml.Name `xml:"series_item"`

	// BGColor is the hexidecimal code for the Nintendo Amiibo product.
	BGColor string `xml:"bgcolor"`

	// Color is the hexidecimal code for the Nintendo Amiibo product.
	Color string `xml:"color"`

	// Name is the name of the Nintendo product in Japanese Hiragana.
	Name string `xml:"name"`
}

type JPNSoftware struct {

	// ID is the fully qualified ID for the Nintendo software product given by Nintendo Japan.
	ID string `json:"id"`

	// Name is the official name of the Nintendo software product.
	//
	// Name contains Japanese Hiragana.
	Name string `json:"name"`

	// NameAlternative is the alternative name given to the Nintendo software product.
	//
	// NameAlternative contains Japanese Hiragana.
	NameAlternative string `json:"name_alternative"`

	// Platform is the Nintendo hardware platform the software is available on.
	Platform string `json:"platform"`

	// Price is the price of the Nintendo software product in JPY.
	//
	// Price can be empty.
	Price string `json:"price"`

	Priority string `json:"priority"`

	// ReleaseDate is the formatted timestamp of the Nintendo software products release date.
	ReleaseDate time.Time `json:"release_date"`

	// URL is the direct URL to the Nintendo software product page.
	URL string `json:"url"`
}

type JPNSoftwareMap (map[string]JPNSoftware)

type Software interface {
	GetAvailable() bool
	GetID() string
	GetLanguage() language.Tag
	GetMD5() (string, []byte, error)
	GetName() string
	GetNameAlternative() string
	GetReleaseDate() time.Time
	GetURL() string
}