api

type Addr struct {
	Address string `json:"address"`
	Netmask string `json:"netmask"`
}

type AllDeviceWrapper struct {
	Devices []*Device `json:"devices"`
}

type Client struct {
	ClientConfig

	*http.Client
	// contains filtered or unexported fields
}

type ClientConfig struct {
	Email   string
	Token   string
	Timeout time.Duration
	Retries int
	API     *url.URL
	Proxy   *url.URL

	Logger interface{}
}

type Column struct {
	ID   uint64 `json:"field_id,string"`
	Name string `json:"col_name"`
	Type string `json:"col_type"`
}

type DNSQuestion struct {
	Name string
	Host []byte
}

type DNSResourceRecord struct {
	Name  string // unused
	CNAME string
	IP    []byte
	TTL   uint32
}

type DNSResponse struct {
	Question DNSQuestion
	Answers  []DNSResourceRecord
}

type Device struct {
	ID          int      `json:"id,string"`
	Name        string   `json:"device_name"`
	Type        string   `json:"device_type"`
	Subtype     string   `json:"device_subtype"`
	Description string   `json:"device_description"`
	IP          net.IP   `json:"ip"`
	SampleRate  int      `json:"device_sample_rate,string"`
	BgpType     string   `json:"device_bgp_type"`
	Plan        Plan     `json:"plan"`
	CdnAttr     string   `json:"cdn_attr"`
	MaxFlowRate int      `json:"max_flow_rate"`
	CompanyID   int      `json:"company_id,string"`
	Customs     []Column `json:"custom_column_data,omitempty"`
}

type DeviceCreate struct {
	Name        string `json:"device_name"`
	Type        string `json:"device_type"`
	Subtype     string `json:"device_subtype"`
	Description string `json:"device_description"`
	SampleRate  int    `json:"device_sample_rate,string"`
	BgpType     string `json:"device_bgp_type"`
	PlanID      int    `json:"plan_id,omitempty"`
	SiteID      int    `json:"site_id,omitempty"`

	CdnAttr string `json:"cdn_attr"`

	// IPs is the associated sending IP Address(es) for the device. For devices that do not have a set of permanent IP
	// addresses (i.e. cloud devices), this should not be set and AllowNoIP should be set to true.
	IPs []net.IP `json:"sending_ips"`

	// AllowNoIP is a flag to bypass the requirement of at least one IP address for creation of a device. This is only
	// applicable for devices that do not have a set of permanent IP addresses, such as cloud devices.
	AllowNoIP bool `json:"-"`

	// ExportId the optionally associated Cloud Exporter which first received flow and is creating the device.
	ExportId int `json:"cloud_export_id,omitempty"`

	// Region is the optionally associated cloud region for this device
	Region string `json:"cloud_region,omitempty"`

	// Zone is the optionally associated cloud zone for this device
	Zone string `json:"cloud_zone,omitempty"`
}

type DeviceWrapper struct {
	Device *Device `json:"device"`
}

type DevicesFilter struct {

	// FilterCloud restricts the results to devices that were NOT created by cloud exporters.
	FilterCloud bool `schema:"filterCloud"`

	// CloudOnly restricts the results to ONLY devices created by cloud exporters.
	CloudOnly bool `schema:"cloudOnly"`

	// Subtypes restricts the results to only specific device subtypes. An empty or nil instance indicates no filtering
	// of results.
	Subtypes []string `schema:"subtypes"`

	// AugmentWith specifies which additional, potentially large, payload fields should be hydrated. Some supported
	// options are:
	//   - customColumns -
	//   - plan - The associated Plan for the device
	AugmentWith []string `schema:"augmentWith"`

	// Columns specifies additional, metadata fields i.e. table columns, to retrieve as part of the query. Examples
	// include id, device_name, etc.
	Columns []string `schema:"columns"`
}

type Error struct {
	StatusCode int
	Message    string
}

type ExportStatus struct {
	ID      int    `json:"export_id"`
	Status  string `json:"status"`
	Message string `json:"message"`
}

type Interface struct {
	ID      uint64 `json:"id,string"`
	Index   uint64 `json:"snmp_id,string"`
	Alias   string `json:"snmp_alias"`
	Desc    string `json:"interface_description"`
	Address string `json:"interface_ip"`
	Netmask string `json:"interface_ip_netmask"`
	Addrs   []Addr `json:"secondary_ips"`
}

type InterfaceUpdate struct {
	Index   uint64 `json:"index,string"`
	Alias   string `json:"alias"`
	Desc    string `json:"desc"`
	Speed   uint64 `json:"speed"`
	Type    uint64 `json:"type"`
	Address string `json:"address"`
	Netmask string `json:"netmask"`
	Addrs   []Addr `json:"alias_address"`
}

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

type SiteAndDeviceCreate struct {
	Site   *SiteCreate   `json:"site"`
	Device *DeviceCreate `json:"device"`
}

type SiteCreate struct {
	Title   string `json:"title"`
	City    string `json:"city,omitempty"`
	Region  string `json:"region,omitempty"`
	Country string `json:"country,omitempty"`
}