api_v1

type BGPRoute struct {
	// Prefix is used to define the prefix of the BGP route.
	Prefix *string `json:"prefix"`

	// AsPath is set when the route has an AS path.
	AsPath []int `json:"as_path"`

	// LocalPref is set when the route has a local preference.
	LocalPref *int `json:"local_pref"`

	// NextHop is set when the route has a next hop.
	NextHop *string `json:"next_hop"`

	// Community is used to define a BGP community.
	Community []string `json:"community"`

	// LargeCommunity is used to define a large BGP community.
	LargeCommunity []string `json:"large_community"`
}

type BGPRouteSlice []*BGPRoute

type PingErrorMessage struct {
	// IsTimeout is used to define if the error is a timeout.
	IsTimeout bool `json:"is_timeout"`

	// Message is used to define the error message.
	Message string `json:"message"`
}

type PingResponse struct {
	// Error is not nil if there was an error.
	Error *PingErrorMessage `json:"error,omitempty"`

	// IPAddress is used to define the IP address of the host.
	IPAddress string `json:"ip_address"`

	// Hostname is used to define the hostname. If it is nil, it means the rDNS lookup is not available.
	Hostname *string `json:"hostname"`

	// Latency is the time the round-trip in milliseconds.
	Latency *float64 `json:"latency,omitempty"`
}

type TraceItem struct {
	// Pings is used to define the latency of all pings sent.
	Pings [3]*float64 `json:"pings"`

	// RDNS is used to define the RDNS of the host if valid.
	RDNS *string `json:"rdns"`

	// IPAddress is used to define the IP address of the host.
	IPAddress string `json:"ip_address"`
}

type TraceResponse struct {
	// Traceroute is used to define the traceroute slice.
	Traceroute []*TraceItem `json:"traceroute"`

	// DestinationIP is used to define the destination IP address.
	DestinationIP string `json:"destination_ip"`
}