types

type Address struct {
	ID   ID     `json:"id"`
	Name string `json:"name"`

	// Label of the address
	// The name is directly taken from the data whereas the label is something computed by navitia for better traveler information.
	// If you don't know what to display, display the label
	Label string `json:"label"`

	// Coordinates of the address
	Coord Coordinates `json:"coord"`

	// House number of the address
	HouseNumber uint `json:"house_number"`

	// Administrative regions of the stop area in which is placed the stop area
	Admins []Admin `json:"administrative_regions"`
}

type Admin struct {
	ID   ID     `json:"id"`
	Name string `json:"name"`

	// Label of the address
	// The name is directly taken from the data whereas the label is something computed by navitia for better traveler information.
	// If you don't know what to display, display the label
	Label string `json:"label"`

	// Coordinates of the administrative region
	Coord Coordinates `json:"coord"`

	// Level of the administrative region
	Level int `json:"level"`

	// Zip code of the administrative region
	ZipCode string `json:"zip_code"`
}

type CO2Emissions struct {
	Unit  string
	Value float64
}

type Channel struct {
	// ID of the address
	ID ID `json:"id"`

	// Content Type (text/html etc.) RFC1341.4
	ContentType string `json:"content_type"`

	// Name of the channel
	Name string `json:"name"`

	// Types ?
	Types []string `json:"types,omitempty"`
}

type Code struct {
	Type  string
	Value string
}

type CommercialMode struct {
	// A CommercialMode ID is in the form of "commercial_mode:something"
	ID ID `json:"id"`

	// Name of the commercial mode
	Name string `json:"name"`

	// Physical modes of this commercial modes
	// Example: []PhysicalMode{PhysicalMode{ID: "physical_mode:Tramway", Name: "Tramway"}}
	PhysicalModes []PhysicalMode `json:"physical_modes"`
}

type Company struct {
	// Identifier of the company
	ID string `json:"id"`

	// Name of the company
	Name string `json:"name"`
}

type Container struct {
	ID           ID
	Name         string
	EmbeddedType string
	Quality      int
	// contains filtered or unexported fields
}

type Coordinates struct {
	Longitude float64 `json:"lon"`
	Latitude  float64 `json:"lat"`
}

type DataFreshness string

type Display struct {
	// The headsign associated with the object
	Headsign string

	// The name of the belonging network
	Network string

	// A direction to take
	Direction string

	// The commercial mode in ID Form
	CommercialMode ID

	// The physical mode in ID Form
	PhysicalMode ID

	// The label of the object
	Label string

	// Hexadecimal color of the line
	Color color.Color

	// The text color for this section
	TextColor color.Color

	// The code of the line
	Code string

	// Description
	Description string

	// Equipments on this object
	Equipments []Equipment
}

type Disruption struct {
	// ID of the Disruption
	ID ID `json:"id"`

	// State of the disruption.
	// The state is computed using the application_periods of the disruption and the current time of the query.
	//
	// It can be either "Past", "Active" or "Future"
	Status string `json:"status"`

	// For traceability, ID of original input disruption
	InputDisruptionID ID

	// For traceability: Id of original input impact
	InputImpactID ID

	// Severity gives some categorization element
	Severity Severity

	// Dates where the current disruption is active
	Periods []Period

	// Text to provide to the traveller
	Messages []Message

	// Last Update of that disruption
	LastUpdated time.Time

	// Objects impacted
	Impacted []ImpactedObject

	// The cause of that disruption
	Cause string

	// The category of the disruption.
	// Optional.
	Category string
}

type Effect string

type Equipment string

type ErrInvalidContainer struct {
	// If the Container has a zero ID.
	NoID bool

	// If the PlaceContainer has an EmbeddedType yet non-empty embedded content.
	NoEmbeddedType bool

	// If the PlaceContainer has an unknown EmbeddedType
	UnknownEmbeddedType bool
}

type Fare struct {
	Total currency.Amount
	Found bool
}

type ID string

type ImpactedObject struct {
	// The impacted public transport object
	Object Container `json:"pt_object"`

	// Only for line section impact, the impacted section
	ImpactedSection ImpactedSection `json:"impacted_section"`

	// Only for Trip delay, the list of delays, stop by stop
	ImpactedStops []ImpactedStop `json:"impacted_stops"`
}

type ImpactedSection struct {
	// The start of the disruption, spatially
	From Container `json:"from"`
	// Until this point
	To Container `json:"to"`
}

type ImpactedStop struct {
	// The impacted stop point of the trip
	Point StopPoint

	// New departure hour (format HHMMSS) of the trip on this stop point
	NewDeparture string

	// New arrival hour (format HHMMSS) of the trip on this stop point
	NewArrival string

	// Base departure hour (format HHMMSS) of the trip on this stop point
	BaseDeparture string

	// Base arrival hour (format HHMMSS) of the trip on this stop point
	BaseArrival string

	// Cause of the modification
	Cause string

	// Effect on that StopPoint
	// Can be "added", "deleted", "delayed"
	Effect string
}

type Isochrone geojson.Geometry

type Journey struct {
	Duration  time.Duration
	Transfers uint

	Departure time.Time
	Requested time.Time
	Arrival   time.Time

	CO2Emissions CO2Emissions

	Sections []Section

	From Container
	To   Container

	Type JourneyQualification

	Fare Fare

	//Status from the whole journey taking into acount the most disturbing information retrieved on every object used
	Status Effect
}

type JourneyQualification string

type Line struct {
	// ID is the navitia identifier of the line
	// For example: "line:RAT:M6"
	ID ID

	// Name is the name of the line
	// For example: "Nation - Charles de Gaule Etoile"
	Name string

	// Code is the codename of the line.
	// For example: "6"
	Code string

	// Color is the color given to the line
	// For example: "79BB92" in Hex
	Color color.Color

	// OpeningTime is the opening time of the line
	OpeningTime struct {
		Hours   uint8
		Minutes uint8
		Seconds uint8
	}

	// ClosingTime is the closing time of the line
	ClosingTime struct {
		Hours   uint8
		Minutes uint8
		Seconds uint8
	}

	// Routes contains the routes of the line
	Routes []Route

	// CommercialMode of the line
	CommercialMode CommercialMode

	// PhysicalModes of the line
	PhysicalModes []PhysicalMode
}

type Message struct {
	// The message to bring to the traveler
	Text string `json:"text"`

	// The destination media for this Message.
	Channel *Channel `json:"channel"`
}

type Network struct {
	// ID is the identifier of the network
	ID string `json:"id"`

	// Name is the name of the network
	Name string `json:"name"`
}

type Object interface{}

type POI struct {
	ID   ID     `json:"id"`
	Name string `json:"name"`

	// The name is directly taken from the data whereas the label is something computed by navitia for better traveler information.
	// If you don't know what to display, display the label
	Label string `json:"label"`

	// The type of the POI
	Type POIType `json:"poi_type"`
}

type POIType struct {
	ID   ID     `json:"id"`
	Name string `json:"name"`
}

type PTDateTime struct {
	// Date/Time of departure
	Departure time.Time

	// Date/Time of arrival
	Arrival time.Time
}

type PTMethod string

type PTObject interface{}

type PathSegment struct {
	// The Length of the segment
	Length uint

	// The Name of the way corresponding to the segment
	Name string

	// The duration in seconds of the segment
	Duration time.Duration

	// The angle in degree between the previous segment and this segment
	// = 0 Means going straight
	// < 0 Means turning left
	// > 0 Means turning right
	Direction int
}

type Period struct {
	Begin time.Time `json:"begin"`
	End   time.Time `json:"end"`
}

type PhysicalMode struct {
	// Identifier of the physical mode
	// For example: "physical_mode:Tramway"
	ID ID `json:"id"`

	// Name of the physical mode
	// For example: "Tramway"
	Name string `json:"name"`

	// Commercial modes of this physical mode
	CommercialModes []CommercialMode `json:"commercial_mode"`
}

type Place interface{}

type Region struct {
	// Identifier of the region
	ID ID

	// Name of the region
	Name string

	// Status of the dataset
	Status string

	// Shape of the region.
	// You can use it to check if a particular coordinate is within that MultiPolygon
	Shape *geom.MultiPolygon

	// When was the DataSet created ?
	DatasetCreation time.Time
	// When was it last loaded at navitia.io's end ?
	LastLoaded time.Time

	// When did production start ?
	ProductionStart time.Time
	// When did or when will it stop ?
	ProductionEnd time.Time

	// An error in the dataset.
	// This comes from the server, not from this package.
	Error string
}

type Route struct {
	// Identifier of the route
	// For example: "route:RAT:M6"
	ID ID

	// Name of the route
	// For example:"Nation - Charles de Gaule Etoile"
	Name string

	// Frequence is true when the route has frequency, if it doesn't it stays false
	Frequence bool

	// Line is the line it is connected to
	Line Line

	// Direction is the direction of the route
	// Note: As direction is a Place, it can be a POI in some data
	Direction Container
}

type Section struct {
	Type SectionType
	ID   ID
	Mode string

	// From & To
	From Container
	To   Container

	// Arrival time & departure time
	Departure time.Time
	Arrival   time.Time

	// Duration of travel
	Duration time.Duration

	// The path taken by this section
	Path []PathSegment

	// The path in geojson format
	Geo *geom.LineString

	// List of the stop times of this section
	StopTimes []StopTime

	// Information to display
	Display Display

	// Additional informations, from what I can see this is always a PTMethod
	Additional []PTMethod
}

type SectionType string

type Severity struct {
	// Name of severity
	Name string

	// Priority of the severity. Given by the agency. 0 is the strongest priority, a nil Priority means its undefined (duh).
	Priority *int

	// HTML color for classification
	Color color.Color

	// Effect: Normalized value of the effect on the public transport object
	Effect Effect
}

type StopArea struct {
	ID   ID     `json:"id"`
	Name string `json:"name"`

	// Label of the stop area.
	// The name is directly taken from the data whereas the label is something computed by navitia for better traveler information.
	// If you don't know what to display, display the label
	Label string `json:"label"`

	// Coordinates of the stop area
	Coord Coordinates `json:"coord"`

	// Administrative regions of the stop area in which is placed the stop area
	Admins []Admin `json:"administrative_regions"`

	// Stop points countained in this stop area
	StopPoints []StopPoint `json:"stop_points"`
}

type StopPoint struct {
	ID ID `json:"id"`

	// Name of the stop point
	Name string `json:"name"`

	// Coordinates of the stop point
	Coord Coordinates `json:"coord"`

	// Administrative regions of the stop point
	Admins []Admin `json:"administrative_regions"`

	// List of equipments of the stop point
	Equipments []Equipment `json:"equipment"`

	// Stop Area countaining the stop point
	StopArea *StopArea `json:"stop_area"`
}

type StopTime struct {
	// The PTDateTime of the stop, this stores the info about the arrival & departure
	PTDateTime PTDateTime

	// The stop point in question
	StopPoint StopPoint
}

type TrafficReport struct {
	// Main object (network) and links within its own disruptions
	Network Network

	// List of all disrupted Lines from the network
	Lines []Line

	// List of all disrupted StopAreas from the network
	StopAreas []StopArea
}

type TravelerType string

type Trip struct {
	ID   ID
	Name string
}

type UnmarshalError struct {
	// Type on which the unmarshaller where the error occurred works
	Type string

	// JSON Key where failure occurred
	Key string

	// Name of the key in package
	Name string

	// Value associated with the key
	Value interface{}

	// Message of the error
	Message string

	// Underlying error
	Underlying error

	// Full JSON data
	JSON []byte
}