rail

type Available struct {
	Status string    `json:"status"`
	Date   time.Time `json:"date"`
}

type CancelledTrainsReq struct {
	// Specifies the date for which result is required.
	Date time.Time `validate:"required"`
}

type CancelledTrainsResp struct {
	Trains []TrainSemi `json:"trains,omitempty"`
	Total  *int        `json:"total,omitempty"`

	*Response
}

type CheckSeatReq struct {
	// Specifies the train number.
	TrainNumber uint32 `validate:"required"`
	// Specifies the source station code.
	FromStationCode string `validate:"required"`
	// Specifies the destination station code.
	ToStationCode string `validate:"required"`
	// Specifies the date for which result is required.
	Date time.Time `validate:"required"`
	// Specifies the class code. Ex: SL/AC/2S
	Class string `validate:"required"`
	// Specifies the quota code. Ex: GN etc
	Quota string `validate:"required"`
}

type CheckSeatResp struct {
	Train        *Train      `json:"train,omitempty"`
	FromStation  *Station    `json:"from_station,omitempty"`
	ToStation    *Station    `json:"to_station,omitempty"`
	Quota        *Quota      `json:"quota,omitempty"`
	JourneyClass *Class      `json:"journey_class,omitempty"`
	Availability []Available `json:"availability,omitempty"`

	*Response
}

type Class struct {
	Available *bool  // `json:"available,omitempty"`
	Name      string `json:"name,omitempty"`
	Code      string `json:"code,omitempty"`
}

type Client struct {
	// BaseURL is the base URL of the API server.
	BaseURL *url.URL
	// User agent used when communicating with the API.
	UserAgent string
	// HTTPClient is a reusable http client instance.
	HTTPClient *http.Client

	// Auth holds authenticator function used to authenticate requests.
	//
	// Client methods uses Auth to add APIKey to requests.
	// Use NewAuth(apikey) to generate a new authenticator.
	Auth func(Requester) Requester
}

type Day struct {
	Runs bool   // `json:"runs,omitempty"`
	Code string `json:"code,omitempty"`
}

type ErrAPI struct {
	// Response from the request which returned error.
	Response *http.Response
}

type ExtendedTrain struct {
	*Train

	ToStation              *Station       `json:"to_station,omitempty"`
	FromStation            *Station       `json:"from_station,omitempty"`
	SourceDepartureTime    *time.Time     // `json:"src_departure_time,omitempty"`
	DestinationArrivalTime *time.Time     // `json:"dest_arrival_time,omitempty"`
	TravelDuration         *time.Duration // `json:"travel_time,omitempty"`
}

type LiveTrainStatusReq struct {
	// Specifies the train number.
	TrainNumber uint32 `validate:"required"`
	// Specifies the date for which result is required.
	Date time.Time `validate:"required"`
}

type LiveTrainStatusResp struct {
	Train          *Train     `json:"train,omitempty"`
	CurrentStation *Station   `json:"current_station,omitempty"`
	Route          []Route    `json:"route,omitempty"`
	StartDate      *time.Time // `json:"start_date,omitempty"`
	PositionRemark *string    `json:"position,omitempty"`

	*Response
}

type PNRStatusReq struct {
	PNRNumber uint64 `validate:"required"` // Specifies the pnr number.
}

type PNRStatusResp struct {
	ChartPrepared   *bool       `json:"chart_prepared,omitempty"`
	DateOfJourney   *time.Time  // `json:"doj,omitempty"`
	BoardingPoint   *Station    `json:"boarding_point,omitempty"`
	FromStation     *Station    `json:"from_station,omitempty"`
	ToStation       *Station    `json:"to_station,omitempty"`
	TotalPassengers *int        `json:"total_passengers,omitempty"`
	JourneyClass    *Class      `json:"journey_class,omitempty"`
	Train           *Train      `json:"train,omitempty"`
	Passengers      []Passenger `json:"passengers,omitempty"`
	PNR             *uint64     `json:"pnr,string,omitempty"`
	ReservationUpto *Station    `json:"reservation_upto,omitempty"`

	*Response
}

type Passenger struct {
	Number        *uint16 `json:"no,omitempty"`
	CurrentStatus *string `json:"current_status,omitempty"`
	BookingStatus *string `json:"booking_status,omitempty"`
}

type Quota struct {
	Name string `json:"name"`
	Code string `json:"code"`
}

type Requester interface {
	// Request should generate an HTTP request from parameters.
	Request() (*http.Request, error)
}

type RequesterFunc func() (*http.Request, error)

type RescheduledTrain struct {
	FromStation *Station `json:"from_station,omitempty"`
	ToStation   *Station `json:"to_station,omitempty"`

	TimeDifference  *time.Duration // `json:"time_diff,omitempty"`
	RescheduledDate *time.Time     // `json:"rescheduled_date,omitempty"`
	RescheduledTime *time.Time     // `json:"rescheduled_time,omitempty"`

	*Train
}

type RescheduledTrainsReq struct {
	// Specifies the date for which result is required.
	Date time.Time `validate:"required"`
}

type RescheduledTrainsResp struct {
	Trains []RescheduledTrain `json:"trains,omitempty"`
	*Response
}

type Response struct {
	// The debit key is included in each API response and it contains
	// the value by which the user’s credit was debited. Whether the user will
	// be debited or not depends upon the ResponseCode.
	Debit int `json:"debit"`

	// ResponseCode key included in each response contains the status
	// of the result returned.
	ResponseCode int `json:"response_code"`
}

type Route struct {
	ActualArrivalDate    *time.Time //`json:"actarr_date,omitempty"`
	ScheduledArrivalDate *time.Time //`json:"scharr_date,omitempty"`

	ScheduledArrivalTime   *time.Time //`json:"scharr,omitempty"`
	ScheduledDepartureTime *time.Time //`json:"schdep,omitempty"`
	ActualDepartureTime    *time.Time //`json:"actdep,omitempty"`
	ActualArrivalTime      *time.Time //`json:"actarr,omitempty"`

	HasArrived  *bool `json:"has_arrived,omitempty"`
	HasDeparted *bool `json:"has_departed,omitempty"`

	Station       *Station `json:"station,omitempty"`
	Status        *string  `json:"status,omitempty"`
	LateByMinutes *int     `json:"latemin,omitempty"`
	Distance      *float64 `json:"distance,omitempty"`
	Day           *int     `json:"day,omitempty"`
	Number        *int     `json:"no,omitempty"`
	Halt          *int     `json:"halt,omitempty"`
}

type Station struct {
	Latitude  float64 `json:"lat"`
	Longitude float64 `json:"lng"`
	Name      string  `json:"name"`
	Code      string  `json:"code"`
}

type StationCodeToNameReq struct {
	// Specifies the source station code.
	StationCode string `validate:"required"`
}

type StationNameToCodeReq struct {
	// Specifies the source station name.
	StationName string `validate:"required"`
}

type Stations struct {
	Stations []Station `json:"stations"`
	*Response
}

type SuggestStationReq struct {
	// Specifies the source station name.
	StationName string `validate:"required"`
}

type SuggestTrainByCodeReq struct {
	// Specifies the Train code.
	TrainCode uint32 `validate:"required"`
}

type SuggestTrainByNameReq struct {
	// Specifies the Train name.
	TrainName string `validate:"required"`
}

type Train struct {
	Name    string  `json:"name"`
	Number  uint32  `json:"number,string"`
	Classes []Class `json:"classes,omitempty"`
	Days    []Day   `json:"days,omitempty"`
}

type TrainArrivalsReq struct {
	// Specifies the source station code.
	StationCode string `validate:"required"`

	// Specifies the windows hours to search.
	//
	// Window time in hours to search, valid values are 2 or 4.
	Hours WindowHour `validate:"required"`
}

type TrainArrivalsResp struct {
	Trains []TrainWithTimings `json:"trains,omitempty"`
	Total  *int               `json:"total,omitempty"`

	*Response
}

type TrainBetweenStationsReq struct {
	// Specifies the source station code.
	FromStationCode string `validate:"required"`
	// Specifies the destination station code.
	ToStationCode string `validate:"required"`
	// Specifies the date for which result is required.
	Date time.Time `validate:"required"`
}

type TrainBetweenStationsResp struct {
	Trains []ExtendedTrain `json:"trains,omitempty"`
	Total  *int            `json:"total,omitempty"`

	*Response
}

type TrainByNameReq struct {
	TrainName string `validate:"required"` // Specifies the train name.
}

type TrainByNumberReq struct {
	TrainNumber uint32 `validate:"required"` // Specifies the train number.
}

type TrainFareReq struct {
	// Specifies the train number.
	TrainNumber uint32 `validate:"required"`
	// Specifies the source station code.
	FromStationCode string `validate:"required"`
	// Specifies the destination station code.
	ToStationCode string `validate:"required"`
	// Specifies the age code of passenger
	Age uint8 `url:"age" validate:"required"`
	// Specifies the date for which result is required.
	Date time.Time `validate:"required"`
	// Specifies the class code. Ex: SL/AC/2S
	Class string `validate:"required"`
	// Specifies the quota code. Ex: GN etc
	Quota string `validate:"required"`
}

type TrainFareResp struct {
	FromStation  *Station    `json:"from_station,omitempty"`
	ToStation    *Station    `json:"to_station,omitempty"`
	Quota        *Quota      `json:"quota,omitempty"`
	Train        *Train      `json:"train,omitempty"`
	Fare         *float64    `json:"fare,omitempty"`
	JourneyClass *Class      `json:"journey_class,omitempty"`
	Availability []Available `json:"availability,omitempty"`

	*Response
}

type TrainResp struct {
	Train *Train `json:"train,omitempty"`
	*Response
}

type TrainRouteReq struct {
	TrainNumber uint32 `validate:"required"` // Specifies the train number.
}

type TrainRouteResp struct {
	Train *Train  `json:"train,omitempty"`
	Route []Route `json:"route,omitempty"`

	*Response
}

type TrainSemi struct {
	Source      *Station   `json:"source,omitempty"`
	Destination *Station   `json:"dest,omitempty"`
	Type        *string    `json:"type,omitempty"`
	StartDate   *time.Time //`json:"start_time,omitempty"`

	*Train
}

type TrainWithTimings struct {
	*Train

	DelayArrivalTime       *time.Time //`json:"delayarr,omitempty"`
	DelayDepartureTime     *time.Time //`json:"delaydep,omitempty"`
	ScheduledArrivalTime   *time.Time //`json:"scharr,omitempty"`
	ScheduledDepartureTime *time.Time //`json:"schdep,omitempty"`
	ActualDepartureTime    *time.Time //`json:"actdep,omitempty"`
	ActualArrivalTime      *time.Time //`json:"actarr,omitempty"`
}

type Trains struct {
	Trains []Train `json:"trains,omitempty"`
	*Response
}

type WindowHour uint8