model

package
v0.0.0-...-c5ca51d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 1, 2024 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package model provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version v1.16.2 DO NOT EDIT.

Index

Constants

View Source 
const (
	ApiKeyAuthScopes = "ApiKeyAuth.Scopes"
	BearerAuthScopes = "BearerAuth.Scopes"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type GetV1WeatherDataParams 

type GetV1WeatherDataParams struct {
	// Lat Latitude to get weather conditions for.
	Lat float64 `form:"lat" json:"lat"`

	// Lon Longitude to get weather conditions for.
	Lon float64 `form:"lon" json:"lon"`

	// Appid API ID to Open Weather API.
	Appid string `form:"appid" json:"appid"`
}

GetV1WeatherDataParams defines parameters for GetV1WeatherData.

type Health 

type Health struct {
	Ok *bool `json:"ok,omitempty"`
}

Health Simple Health Check

type MtgBattleCard 

type MtgBattleCard struct {
	// Card The MTG card augmented for battle.
	Card *mtg.Card `json:"card,omitempty"`

	// IsAttacker boolean signaling the card is being used this turn as an attacker within play or battle.
	IsAttacker *bool `json:"is_attacker,omitempty"`

	// IsBlocker boolean signaling the card is being used this turn as a blocker within play or battle.
	IsBlocker *bool `json:"is_blocker,omitempty"`

	// IsTapped boolean signaling the card has been tapped this turn within play or battle.
	IsTapped *bool `json:"is_tapped,omitempty"`

	// Life life of this creature this turn.
	Life *string `json:"life,omitempty"`

	// Power power of attack or defense this turn.
	Power *string `json:"power,omitempty"`
}

MtgBattleCard Magic: The Gathering card data with meta data for in play. This augments the card for in play activities.

type MtgBattleField 

type MtgBattleField struct {
	// Creatures Creatures List
	Creatures []MtgBattleCard `json:"creatures"`

	// Lands Lands / Resources List
	Lands []MtgBattleCard `json:"lands"`
}

MtgBattleField Magic: The Gathering Standard game play meta data

type MtgGameManager 

type MtgGameManager struct {
	// GameFormat Magic offically labels its gameplay as "Begin, Main Phase, Combat, Second Main Phase, and End"; some have subphases. For details see: https://en.wikipedia.org/wiki/Magic:_The_Gathering_rules#Gameplay.
	GameFormat MtgGameManagerGameFormat `json:"game_format"`

	// GamePhase Magic offically labels its gameplay as "Begin, Main Phase, Combat, Second Main Phase, and End"; some have subphases. For details see: https://en.wikipedia.org/wiki/Magic:_The_Gathering_rules#Gameplay.
	GamePhase MtgGameManagerGamePhase `json:"game_phase"`

	// PlayerTurn Current player turn. Index of playerBattleFields.
	PlayerTurn int `json:"player_turn"`

	// Players List Players playing MTG.
	Players     []MtgPlayer     `json:"players"`
	PlayersMeta []MtgPlayerMeta `json:"players_meta"`
}

MtgGameManager Magic: The Gathering Game Manager and Game meta data

type MtgGameManagerGameFormat 

type MtgGameManagerGameFormat string

MtgGameManagerGameFormat Magic offically labels its gameplay as "Begin, Main Phase, Combat, Second Main Phase, and End"; some have subphases. For details see: https://en.wikipedia.org/wiki/Magic:_The_Gathering_rules#Gameplay. 

const (
	MtgGameManagerGameFormatEndCleanup MtgGameManagerGameFormat = "End-Cleanup"
	MtgGameManagerGameFormatEndStep    MtgGameManagerGameFormat = "End-Step"
	MtgGameManagerGameFormatMainSecond MtgGameManagerGameFormat = "Main-Second"
)

Defines values for MtgGameManagerGameFormat.

type MtgGameManagerGamePhase 

type MtgGameManagerGamePhase string

MtgGameManagerGamePhase Magic offically labels its gameplay as "Begin, Main Phase, Combat, Second Main Phase, and End"; some have subphases. For details see: https://en.wikipedia.org/wiki/Magic:_The_Gathering_rules#Gameplay. 

const (
	MtgGameManagerGamePhaseBeginDraw              MtgGameManagerGamePhase = "Begin-Draw"
	MtgGameManagerGamePhaseBeginUntap             MtgGameManagerGamePhase = "Begin-Untap"
	MtgGameManagerGamePhaseBeginUpkeep            MtgGameManagerGamePhase = "Begin-Upkeep"
	MtgGameManagerGamePhaseCombatBeginning        MtgGameManagerGamePhase = "Combat-Beginning"
	MtgGameManagerGamePhaseCombatDamage           MtgGameManagerGamePhase = "Combat-Damage"
	MtgGameManagerGamePhaseCombatDeclareAttackers MtgGameManagerGamePhase = "Combat-Declare-Attackers"
	MtgGameManagerGamePhaseCombatDeclareBlockers  MtgGameManagerGamePhase = "Combat-Declare-Blockers"
	MtgGameManagerGamePhaseCombatEnd              MtgGameManagerGamePhase = "Combat-End"
	MtgGameManagerGamePhaseEndCleanup             MtgGameManagerGamePhase = "End-Cleanup"
	MtgGameManagerGamePhaseEndStep                MtgGameManagerGamePhase = "End-Step"
	MtgGameManagerGamePhaseMainFirst              MtgGameManagerGamePhase = "Main-First"
	MtgGameManagerGamePhaseMainSecond             MtgGameManagerGamePhase = "Main-Second"
)

Defines values for MtgGameManagerGamePhase.

type MtgPlayer 

type MtgPlayer struct {
	// Deck Deck cards List. Rules of the Deck: 60 Card minimum, 4 limit on copies (exception for basic lands).
	Deck []mtg.Card `json:"deck"`

	// Name Player Name
	Name string `json:"name"`

	// Zones Cards in each Zone
	Zones []MtgZones `json:"zones"`
}

MtgPlayer Magic: The Gathering Standard game play meta data

type MtgPlayerMeta 

type MtgPlayerMeta struct {
	// CardCount Number of cards in deck
	CardCount int `json:"card_count"`

	// ColorCount Number of color types in deck
	ColorCount int `json:"color_count"`

	// Colors Color types in deck listed
	Colors []string `json:"colors"`

	// CreatureCount Number of creature cards in deck
	CreatureCount int `json:"creature_count"`

	// Errs List of errors from players' decks or other data. Empty list signals all players are valid and ready to play.
	Errs []map[string]interface{} `json:"errs"`

	// LandCount Number of land cards in deck
	LandCount int `json:"land_count"`

	// Meta Map of various stats on the deck.
	Meta map[string]interface{} `json:"meta"`

	// RepeatedCards Map of cards and number of times repeated in deck
	RepeatedCards []string `json:"repeated_cards"`

	// SpellCount Number of spell cards in deck
	SpellCount int `json:"spell_count"`
}

MtgPlayerMeta Magic: The Gathering Standard game play meta data

type MtgZones 

type MtgZones struct {
	// Battlefield Cards in Battlefield
	Battlefield []struct {
		// Creatures Creatures List
		Creatures []MtgBattleCard `json:"creatures"`

		// Lands Lands / Resources List
		Lands []MtgBattleCard `json:"lands"`
	} `json:"battlefield"`

	// Exile Lands / Resources List
	Exile []MtgBattleCard `json:"exile"`

	// Graveyard Lands / Resources List
	Graveyard []MtgBattleCard `json:"graveyard"`

	// Hand List of cards in Player hand
	Hand []MtgBattleCard `json:"hand"`

	// Library Lands / Resources List
	Library []MtgBattleCard `json:"library"`

	// TheStack Spells unresolved List
	TheStack []MtgBattleCard `json:"the_stack"`
}

MtgZones Magic: The Gathering Standard game play meta data

type OpenWeatherMapParametersGetCurrentData 

type OpenWeatherMapParametersGetCurrentData struct {
	// AppId The API Key for access to OpenWeatherMap API
	AppId *string `json:"appid"`

	// Language Change the language the response is in. Default is English.
	Language *string `json:"lang"`

	// Latitude The latitude for which temperature data is retrieved for.
	Latitude *float64 `json:"lat"`

	// Longitude The longitude for which temperature data is retrieved for.
	Longitude *float64 `json:"lon"`

	// Mode Response format. Possible values are xml and html. If you don't use the mode parameter format is JSON by default.
	Mode *string `json:"mode"`

	// Units Change the units the temperature response is in. Can be [standard, metric, imperial]. Where standard is absolute or Kelvin, metric is Celsius, imperial is Fahrenheit.
	Units *string `json:"units"`
}

OpenWeatherMapParametersGetCurrentData Open Weather Map API Parameters for Get Weather Data. See OpenWeatherMap details on APIs: https://openweathermap.org/current

type OpenWeatherMapResponse 

type OpenWeatherMapResponse struct {
	Base string `json:"base"`

	// Clouds Open Weather API Clouds Data.
	Clouds OpenWeatherMapResponseClouds `json:"Clouds"`
	Cod    int64                        `json:"cod"`

	// Coordinates Open Weather API Coordinates Data.
	Coordinates OpenWeatherMapResponseCoordinates `json:"Coordinates"`
	Id          int64                             `json:"id"`

	// Main Open Weather API Main Data.
	Main OpenWeatherMapResponseMain `json:"Main"`
	Name string                     `json:"name"`

	// Rain Open Weather API Rain Data.
	Rain *OpenWeatherMapResponseRain `json:"Rain,omitempty"`

	// Snow Open Weather API Snow Data.
	Snow *OpenWeatherMapResponseSnow `json:"Snow,omitempty"`

	// System Open Weather API System Data.
	System     OpenWeatherMapResponseSystem `json:"System"`
	TimeData   float64                      `json:"dt"`
	TimeZone   *int64                       `json:"timezone"`
	Visibility float64                      `json:"visibility"`

	// Weather Open Weather API Weather Data.
	Weather []OpenWeatherMapResponseWeather `json:"weather"`

	// Wind Open Weather API Wind Data.
	Wind OpenWeatherMapResponseWind `json:"Wind"`
}

OpenWeatherMapResponse Open Weather API Response to GET Current Data: https://api.openweathermap.org/data/2.5/weather.

type OpenWeatherMapResponseClouds 

type OpenWeatherMapResponseClouds struct {
	// CloudinessPercent Cloudiness, %
	CloudinessPercent float64 `json:"all"`
}

OpenWeatherMapResponseClouds Open Weather API Clouds Data.

type OpenWeatherMapResponseCoordinates 

type OpenWeatherMapResponseCoordinates struct {
	// Latitude Longitude of the location
	Latitude float64 `json:"lat"`

	// Longitude Latitude of the location
	Longitude float64 `json:"lon"`
}

OpenWeatherMapResponseCoordinates Open Weather API Coordinates Data.

type OpenWeatherMapResponseMain 

type OpenWeatherMapResponseMain struct {
	// FeelsLike Temperature. This temperature parameter accounts for the human perception of weather. Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
	FeelsLike float64 `json:"feels_like"`

	// GroundLevel Atmospheric pressure on the ground level, hPa
	GroundLevel float64 `json:"grnd_level"`

	// Humidity Humidity, %
	Humidity float64 `json:"humidity"`

	// Pressure Atmospheric pressure on the sea level, hPa
	Pressure float64 `json:"pressure"`

	// SeaLevel Atmospheric pressure on the sea level, hPa
	SeaLevel float64 `json:"sea_level"`

	// Temperature Temperature. Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
	Temperature float64 `json:"temp"`

	// TemperatureMax Maximum temperature at the moment. This is maximal currently observed temperature (within large megalopolises and urban areas). Please find more info here. Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
	TemperatureMax float64 `json:"temp_max"`

	// TemperatureMin Minimum temperature at the moment. This is minimal currently observed temperature (within large megalopolises and urban areas). Please find more info here. Unit Default: Kelvin, Metric: Celsius, Imperial: Fahrenheit
	TemperatureMin float64 `json:"temp_min"`
}

OpenWeatherMapResponseMain Open Weather API Main Data.

type OpenWeatherMapResponseRain 

type OpenWeatherMapResponseRain struct {
	// Volume1Hour (where available) Rain volume for the last 1 hour, mm. Please note that only mm as units of measurement are available for this parameter
	Volume1Hour float64 `json:"1h"`

	// Volume3Hour (where available) Rain volume for the last 3 hours, mm. Please note that only mm as units of measurement are available for this parameter
	Volume3Hour float64 `json:"3h"`
}

OpenWeatherMapResponseRain Open Weather API Rain Data.

type OpenWeatherMapResponseSnow 

type OpenWeatherMapResponseSnow struct {
	// Volume1Hour (where available) Snow volume for the last 1 hour, mm. Please note that only mm as units of measurement are available for this parameter
	Volume1Hour float64 `json:"1h"`

	// Volume3Hour (where available) Snow volume for the last 3 hours, mm. Please note that only mm as units of measurement are available for this parameter
	Volume3Hour float64 `json:"3h"`
}

OpenWeatherMapResponseSnow Open Weather API Snow Data.

type OpenWeatherMapResponseSystem 

type OpenWeatherMapResponseSystem struct {
	// Country Country code (GB, JP etc.)
	Country string `json:"country"`

	// Id Internal parameter
	Id int64 `json:"id"`

	// Message Internal parameter
	Message string `json:"message"`

	// Sunrise Sunrise time, unix, UTC
	Sunrise int64 `json:"sunrise"`

	// Sunset Sunset time, unix, UTC
	Sunset int64 `json:"sunset"`

	// Type Internal parameter
	Type int64 `json:"type"`
}

OpenWeatherMapResponseSystem Open Weather API System Data.

type OpenWeatherMapResponseWeather 

type OpenWeatherMapResponseWeather struct {
	// Description Weather condition within the group. Please find more here. You can get the output in your language.
	Description string `json:"description"`

	// Icon Weather icon id
	Icon string `json:"icon"`

	// Id Weather condition id
	Id int64 `json:"id"`

	// Main Group of weather parameters (Rain, Snow, Clouds etc.)
	Main string `json:"main"`
}

OpenWeatherMapResponseWeather Open Weather API Weather Data.

type OpenWeatherMapResponseWind 

type OpenWeatherMapResponseWind struct {
	// Gust Wind gust. Unit Default: meter/sec, Metric: meter/sec, Imperial: miles/hour
	Gust float64 `json:"gust"`

	// Speed Wind speed. Unit Default: meter/sec, Metric: meter/sec, Imperial: miles/hour
	Speed float64 `json:"speed"`

	// WindDirectionDegrees Wind direction, degrees (meteorological)
	WindDirectionDegrees float64 `json:"deg"`
}

OpenWeatherMapResponseWind Open Weather API Wind Data.

type WeatherConditionGetParameters 

type WeatherConditionGetParameters struct {
	// AppId OpenWeatherMap API ID/Key generated by signing up to use their APIs
	AppId *string `json:"appid"`

	// Latitude latitude of location on earth to get weather data for
	Latitude *float64 `json:"lat"`

	// Longitude longitude of location on earth to get weather data for
	Longitude *float64 `json:"lon"`
}

WeatherConditionGetParameters Weather Web App Parameters for Get Weather Data

func (WeatherConditionGetParameters) Validate 

func (p WeatherConditionGetParameters) Validate() error

type WeatherConditionGetResponse 

type WeatherConditionGetResponse struct {
	// City The City found at the latitude & longitude
	City string `json:"city"`

	// OutsideCondition The outside condition.
	OutsideCondition string `json:"outside_condition"`

	// Temperature The temperature in degrees fahrenheit
	Temperature string `json:"temperature"`

	// TemperatureCondition The temperature condition.
	TemperatureCondition string `json:"temperature_condition"`
}

WeatherConditionGetResponse Weather Web App Parameters for Get Weather Data

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.