apiclient

type API struct {
	Log Logger

	Debug bool
	// contains filtered or unexported fields
}

type Account struct {
	CID                  string          `json:"_cid,omitempty"` // string
	AccountUUID          string          `json:"_account_uuid,omitempty"`
	Country              string          `json:"country_code,omitempty"`           // string
	Name                 string          `json:"name,omitempty"`                   // string
	OwnerCID             string          `json:"_owner,omitempty"`                 // string
	Timezone             string          `json:"timezone,omitempty"`               // string
	UIBaseURL            string          `json:"_ui_base_url,omitempty"`           // string
	PrivateC3DataURL     string          `json:"_c3_data_url,omitempty"`           // string
	C3DataURL            string          `json:"c3_data_url,omitempty"`            // string
	Address1             *string         `json:"address1,omitempty"`               // string or null
	Address2             *string         `json:"address2,omitempty"`               // string or null
	CCEmail              *string         `json:"cc_email,omitempty"`               // string or null
	City                 *string         `json:"city,omitempty"`                   // string or null
	DefaultDashboardUUID *string         `json:"default_dashboard_uuid,omitempty"` // string or null
	DefaultDashboardType *string         `json:"default_dashboard_type,omitempty"` // string or null
	Description          *string         `json:"description,omitempty"`            // string or null
	StateProv            *string         `json:"state_prov,omitempty"`             // string or null
	ContactGroups        []string        `json:"_contact_groups,omitempty"`        // [] len >= 0
	Invites              []AccountInvite `json:"invites,omitempty"`                // [] len >= 0
	Usage                []AccountLimit  `json:"_usage,omitempty"`                 // [] len >= 0
	Users                []AccountUser   `json:"users,omitempty"`                  // [] len >= 0
}

type AccountInvite struct {
	Email string `json:"email"` // string
	Role  string `json:"role"`  // string
}

type AccountLimit struct {
	Type  string `json:"_type,omitempty"`  // string
	Limit uint   `json:"_limit,omitempty"` // uint >=0
	Used  uint   `json:"_used,omitempty"`  // uint >=0
}

type AccountUser struct {
	Role    string `json:"role"` // string
	UserCID string `json:"user"` // string
}

type Acknowledgement struct {
	AcknowledgedUntil interface{} `json:"acknowledged_until,omitempty"` // NOTE received as uint; can be set using string or uint
	AlertCID          string      `json:"alert,omitempty"`              // string
	CID               string      `json:"_cid,omitempty"`               // string
	LastModifiedBy    string      `json:"_last_modified_by,omitempty"`  // string
	Notes             string      `json:"notes,omitempty"`              // string
	AcknowledgedBy    string      `json:"_acknowledged_by,omitempty"`   // string
	AcknowledgedOn    uint        `json:"_acknowledged_on,omitempty"`   // uint
	LastModified      uint        `json:"_last_modified,omitempty"`     // uint
	Active            bool        `json:"_active,omitempty"`            // bool
}

type Alert struct {
	AlertURL           string   `json:"_alert_url,omitempty"`       // string
	BrokerCID          string   `json:"_broker,omitempty"`          // string
	CheckCID           string   `json:"_check,omitempty"`           // string
	CheckName          string   `json:"_check_name,omitempty"`      // string
	CID                string   `json:"_cid,omitempty"`             // string
	Value              string   `json:"_value,omitempty"`           // string
	MetricName         string   `json:"_metric_name,omitempty"`     // string
	RuleSetCID         string   `json:"_rule_set,omitempty"`        // string
	AcknowledgementCID *string  `json:"_acknowledgement,omitempty"` // string or null
	ClearedValue       *string  `json:"_cleared_value,omitempty"`   // string or null
	MetricLinkURL      *string  `json:"_metric_link,omitempty"`     // string or null
	MetricNotes        *string  `json:"_metric_notes,omitempty"`    // string or null
	ClearedOn          *uint    `json:"_cleared_on,omitempty"`      // uint or null
	Maintenance        []string `json:"_maintenance,omitempty"`     // [] len >= 0
	Tags               []string `json:"_tags,omitempty"`            // [] len >= 0
	OccurredOn         uint     `json:"_occurred_on,omitempty"`     // uint
	Severity           uint     `json:"_severity,omitempty"`        // uint
}

type Annotation struct {
	Category       string   `json:"category"`                    // string
	CID            string   `json:"_cid,omitempty"`              // string
	Description    string   `json:"description"`                 // string
	LastModifiedBy string   `json:"_last_modified_by,omitempty"` // string
	Title          string   `json:"title"`                       // string
	RelatedMetrics []string `json:"rel_metrics"`                 // [] len >= 0
	LastModified   uint     `json:"_last_modified,omitempty"`    // uint
	Created        uint     `json:"_created,omitempty"`          // uint
	Start          uint     `json:"start"`                       // uint
	Stop           uint     `json:"stop"`                        // uint
}

type Broker struct {
	CID       string         `json:"_cid"`       // string
	Name      string         `json:"_name"`      // string
	Type      string         `json:"_type"`      // string
	Latitude  *string        `json:"_latitude"`  // string or null
	Longitude *string        `json:"_longitude"` // string or null
	Tags      []string       `json:"_tags"`      // [] len >= 0
	Details   []BrokerDetail `json:"_details"`   // [] len >= 1
}

type BrokerDetail struct {
	CN           string   `json:"cn"`                       // string
	Status       string   `json:"status"`                   // string
	ClusterIP    *string  `json:"cluster_ip"`               // string or null
	ExternalHost *string  `json:"external_host"`            // string or null
	IP           *string  `json:"ipaddress"`                // string or null
	Skew         *string  `json:"skew"`                     // BUG doc: floating point number, api object: string or null
	Port         *uint16  `json:"port"`                     // uint16 or null
	Version      *uint    `json:"version"`                  // uint or null
	Modules      []string `json:"modules"`                  // [] len >= 0
	ExternalPort uint16   `json:"external_port"`            // uint16
	MinVer       uint     `json:"minimum_version_required"` // uint
}

type BrokerStratcon struct {
	CN   string `json:"cn,omitempty"`   // string
	Host string `json:"host,omitempty"` // string
	Port string `json:"port,omitempty"` // string
}

type CIDType *string

type ChartTextWidgetDatapoint struct {
	AccountID    string `json:"account_id,omitempty"`     // metric cluster, metric
	ClusterTitle string `json:"_cluster_title,omitempty"` // metric cluster
	Label        string `json:"label,omitempty"`          // metric
	Label2       string `json:"_label,omitempty"`         // metric cluster
	Metric       string `json:"metric,omitempty"`         // metric
	MetricType   string `json:"_metric_type,omitempty"`   // metric
	CheckID      uint   `json:"_check_id,omitempty"`      // metric
	ClusterID    uint   `json:"cluster_id,omitempty"`     // metric cluster
	NumericOnly  bool   `json:"numeric_only,omitempty"`   // metric cluster
}

type ChartWidgetDefinitionLegend struct {
	Type string `json:"type,omitempty"`
	Show bool   `json:"show,omitempty"`
}

type ChartWidgetWedgeLabels struct {
	OnChart  bool `json:"on_chart,omitempty"`
	ToolTips bool `json:"tooltips,omitempty"`
}

type ChartWidgetWedgeValues struct {
	Angle string `json:"angle,omitempty"`
	Color string `json:"color,omitempty"`
	Show  bool   `json:"show,omitempty"`
}

type ChartWidgtDefinition struct {
	Datasource        string                      `json:"datasource,omitempty"`
	Derive            string                      `json:"derive,omitempty"`
	Formula           string                      `json:"formula,omitempty"`
	WedgeValues       ChartWidgetWedgeValues      `json:"wedge_values,omitempty"`
	Legend            ChartWidgetDefinitionLegend `json:"legend,omitempty"`
	Period            uint                        `json:"period,omitempty"`
	WedgeLabels       ChartWidgetWedgeLabels      `json:"wedge_labels,omitempty"`
	DisableAutoformat bool                        `json:"disable_autoformat,omitempty"`
	PopOnHover        bool                        `json:"pop_onhover,omitempty"`
}

type Check struct {
	BrokerCID      string       `json:"_broker"`       // string
	CheckBundleCID string       `json:"_check_bundle"` // string
	CheckUUID      string       `json:"_check_uuid"`   // string
	CID            string       `json:"_cid"`          // string
	Details        CheckDetails `json:"_details"`      // NOTE contents of details are check type specific, map len >= 0
	ReverseURLs    []string     `json:"_reverse_urls"` // []string list of reverse urls (one per broker in cluster)
	Active         bool         `json:"_active"`       // bool
}

type CheckBundle struct {
	CID                string              `json:"_cid,omitempty"`                     // string
	Status             string              `json:"status,omitempty"`                   // string
	DisplayName        string              `json:"display_name"`                       // string
	LastModifedBy      string              `json:"_last_modifed_by,omitempty"`         // string
	Target             string              `json:"target"`                             // string
	Type               string              `json:"type"`                               // string
	Notes              *string             `json:"notes,omitempty"`                    // string or null
	Config             CheckBundleConfig   `json:"config"`                             // NOTE contents of config are check type specific, map len >= 0
	Brokers            []string            `json:"brokers"`                            // [] len >= 0
	Checks             []string            `json:"_checks,omitempty"`                  // [] len >= 0
	CheckUUIDs         []string            `json:"_check_uuids,omitempty"`             // [] len >= 0
	ReverseConnectURLs []string            `json:"_reverse_connection_urls,omitempty"` // [] len >= 0
	Tags               []string            `json:"tags,omitempty"`                     // [] len >= 0
	MetricFilters      [][]string          `json:"metric_filters,omitempty"`           // [][type,rule_regx,comment]
	Metrics            []CheckBundleMetric `json:"metrics"`                            // [] >= 0
	Timeout            float32             `json:"timeout,omitempty"`                  // float32
	Period             uint                `json:"period,omitempty"`                   // uint
	Created            uint                `json:"_created,omitempty"`                 // uint
	LastModified       uint                `json:"_last_modified,omitempty"`           // uint
	MetricLimit        int                 `json:"metric_limit,omitempty"`             // int
}

type CheckBundleConfig map[config.Key]string

type CheckBundleMetric struct {
	Name   string   `json:"name"`             // string
	Type   string   `json:"type"`             // string
	Status string   `json:"status,omitempty"` // string
	Result *string  `json:"result,omitempty"` // string or null, NOTE not settable - return/information value only
	Units  *string  `json:"units,omitempty"`  // string or null
	Tags   []string `json:"tags"`             // [] len >= 0
}

type CheckBundleMetrics struct {
	CID     string              `json:"_cid,omitempty"` // string
	Metrics []CheckBundleMetric `json:"metrics"`        // See check_bundle.go for CheckBundleMetric definition
}

type CheckDetails map[config.Key]string

type Config struct {
	Log Logger
	// TLSConfig defines a custom tls configuration to use when communicating with the API
	TLSConfig *tls.Config
	// CACert deprecating, use TLSConfig instead
	CACert *x509.CertPool
	// URL defines the API URL - default https://api.circonus.com/v2/
	URL string
	// TokenKey defines the key to use when communicating with the API
	TokenKey string
	// TokenApp defines the app to use when communicating with the API
	TokenApp       string
	TokenAccountID string
	MinRetryDelay  string
	MaxRetryDelay  string
	MaxRetries     uint
	DisableRetries bool
	Debug          bool
}

type ContactGroup struct {
	CID               string                    `json:"_cid,omitempty"`               // string
	LastModifiedBy    string                    `json:"_last_modified_by,omitempty"`  // string
	Name              string                    `json:"name,omitempty"`               // string
	GroupType         string                    `json:"group_type,omitempty"`         // string - new 2019-10-09
	AlertFormats      ContactGroupAlertFormats  `json:"alert_formats,omitempty"`      // ContactGroupAlertFormats
	Contacts          ContactGroupContacts      `json:"contacts,omitempty"`           // ContactGroupContacts
	Escalations       []*ContactGroupEscalation `json:"escalations,omitempty"`        // [] len == 5, elements: ContactGroupEscalation or null
	Reminders         []uint                    `json:"reminders,omitempty"`          // [] len == 5
	Tags              []string                  `json:"tags,omitempty"`               // [] len >= 0
	LastModified      uint                      `json:"_last_modified,omitempty"`     // uint
	AggregationWindow uint                      `json:"aggregation_window,omitempty"` // uint
	AlwaysSendClear   bool                      `json:"always_send_clear,omitempty"`  // bool - new 2019-10-09
}

type ContactGroupAlertFormats struct {
	LongMessage  *string `json:"long_message,omitempty"`  // string - 2019-10-09 null no longer accepted, must be omitted if not set
	LongSubject  *string `json:"long_subject,omitempty"`  // string - 2019-10-09 null no longer accepted, must be omitted if not set
	LongSummary  *string `json:"long_summary,omitempty"`  // string - 2019-10-09 null no longer accepted, must be omitted if not set
	ShortMessage *string `json:"short_message,omitempty"` // string - 2019-10-09 null no longer accepted, must be omitted if not set
	ShortSummary *string `json:"short_summary,omitempty"` // string - 2019-10-09 null no longer accepted, must be omitted if not set
}

type ContactGroupContacts struct {
	External []ContactGroupContactsExternal `json:"external"` // [] len >= 0
	Users    []ContactGroupContactsUser     `json:"users"`    // [] len >= 0
}

type ContactGroupContactsExternal struct {
	Info   string `json:"contact_info"` // string
	Method string `json:"method"`       // string
}

type ContactGroupContactsUser struct {
	Info    string `json:"_contact_info,omitempty"` // string
	Method  string `json:"method"`                  // string
	UserCID string `json:"user"`                    // string
}

type ContactGroupEscalation struct {
	ContactGroupCID string `json:"contact_group"` // string
	After           uint   `json:"after"`         // uint
}

type Dashboard struct {
	CID          string              `json:"_cid,omitempty"`
	CreatedBy    string              `json:"_created_by,omitempty"`
	Title        string              `json:"title"`
	UUID         string              `json:"_dashboard_uuid,omitempty"`
	Widgets      []DashboardWidget   `json:"widgets"`
	Options      DashboardOptions    `json:"options"`
	GridLayout   DashboardGridLayout `json:"grid_layout"`
	Created      uint                `json:"_created,omitempty"`
	LastModified uint                `json:"_last_modified,omitempty"`
	Active       bool                `json:"_active,omitempty"`
	Shared       bool                `json:"shared"`
}

type DashboardAccessConfig struct {
	Nickname            string `json:"nickname"`
	SharedID            string `json:"shared_id"`
	TextSize            uint   `json:"text_size"`
	BlackDash           bool   `json:"black_dash"`
	Enabled             bool   `json:"enabled"`
	Fullscreen          bool   `json:"fullscreen"`
	FullscreenHideTitle bool   `json:"fullscreen_hide_title"`
	ScaleText           bool   `json:"scale_text"`
}

type DashboardGridLayout struct {
	Height uint `json:"height"`
	Width  uint `json:"width"`
}

type DashboardOptions struct {
	AccessConfigs       []DashboardAccessConfig `json:"access_configs"`
	Linkages            [][]string              `json:"linkages"`
	TextSize            uint                    `json:"text_size"`
	FullscreenHideTitle bool                    `json:"fullscreen_hide_title"`
	HideGrid            bool                    `json:"hide_grid"`
	ScaleText           bool                    `json:"scale_text"`
}

type DashboardWidget struct {
	Name     string                  `json:"name"`
	Origin   string                  `json:"origin"`
	Type     string                  `json:"type"`
	WidgetID string                  `json:"widget_id"`
	Settings DashboardWidgetSettings `json:"settings"`
	Height   uint                    `json:"height"`
	Width    uint                    `json:"width"`
	Active   bool                    `json:"active"`
}

type DashboardWidgetSettings struct {
	Definition          *ChartWidgtDefinition            `json:"definition,omitempty"`            // charts
	AgentStatusSettings *StatusWidgetAgentStatusSettings `json:"agent_status_settings,omitempty"` // status
	HostStatusSettings  *StatusWidgetHostStatusSettings  `json:"host_status_settings,omitempty"`  // status
	Thresholds          *ForecastGaugeWidgetThresholds   `json:"thresholds,omitempty"`            // forecasts, gauges
	RangeHigh           *int                             `json:"range_high,omitempty"`            // gauges 2019-11-01 switch to pointer for 0 ranges
	RangeLow            *int                             `json:"range_low,omitempty"`             // gauges 2019-11-01 switch to pointer for 0 ranges
	ShowValue           *bool                            `json:"show_value,omitempty"`            // state
	AccountID           string                           `json:"account_id,omitempty"`            // alerts, clusters, gauges, graphs, lists, state, status
	Acknowledged        string                           `json:"acknowledged,omitempty"`          // alerts
	Algorithm           string                           `json:"algorithm,omitempty"`             // clusters
	BodyFormat          string                           `json:"body_format,omitempty"`           // text
	Caql                string                           `json:"caql,omitempty"`                  // state
	ChartType           string                           `json:"chart_type,omitempty"`            // charts
	CheckUUID           string                           `json:"check_uuid,omitempty"`            // gauges, state
	Cleared             string                           `json:"cleared,omitempty"`               // alerts
	ClusterName         string                           `json:"cluster_name,omitempty"`          // clusters
	ContentType         string                           `json:"content_type,omitempty"`          // status
	DateWindow          string                           `json:"date_window,omitempty"`           // graphs
	Dependents          string                           `json:"dependents,omitempty"`            // alerts
	Display             string                           `json:"display,omitempty"`               // alerts
	DisplayMarkup       string                           `json:"display_markup,omitempty"`        // state
	Format              string                           `json:"format,omitempty"`                // forecasts
	Formula             string                           `json:"formula,omitempty"`               // gauges
	GoodColor           string                           `json:"good_color,omitempty"`            // state
	GraphUUID           string                           `json:"graph_id,omitempty"`              // graphs
	KeyLoc              string                           `json:"key_loc,omitempty"`               // graphs
	Label               string                           `json:"label,omitempty"`                 // graphs
	Layout              string                           `json:"layout,omitempty"`                // clusters
	LayoutStyle         string                           `json:"layout_style,omitempty"`          // state
	LinkURL             string                           `json:"link_url,omitempty"`              // state
	Maintenance         string                           `json:"maintenance,omitempty"`           // alerts
	Markup              string                           `json:"markup,omitempty"`                // html
	MetricDisplayName   string                           `json:"metric_display_name,omitempty"`   // gauges, state
	MetricName          string                           `json:"metric_name,omitempty"`           // gauges, state
	MetricType          string                           `json:"metric_type,omitempty"`           // state
	MinAge              string                           `json:"min_age,omitempty"`               // alerts
	OverlaySetID        string                           `json:"overlay_set_id,omitempty"`        // graphs
	ResourceLimit       string                           `json:"resource_limit,omitempty"`        // forecasts
	ResourceUsage       string                           `json:"resource_usage,omitempty"`        // forecasts
	Search              string                           `json:"search,omitempty"`                // alerts, lists
	Severity            string                           `json:"severity,omitempty"`              // alerts
	Size                string                           `json:"size,omitempty"`                  // clusters
	TextAlign           string                           `json:"text_align,omitempty"`            // state
	TimeWindow          string                           `json:"time_window,omitempty"`           // alerts
	Title               string                           `json:"title,omitempty"`                 // alerts, charts, forecasts, gauges, html, state
	TitleFormat         string                           `json:"title_format,omitempty"`          // text
	Trend               string                           `json:"trend,omitempty"`                 // forecasts
	Type                string                           `json:"type,omitempty"`                  // gauges, lists
	ValueType           string                           `json:"value_type,omitempty"`            // gauges, text
	TagFilterSet        []string                         `json:"tag_filter_set,omitempty"`        // alerts
	WeekDays            []string                         `json:"weekdays,omitempty"`              // alerts
	BadRules            []StateWidgetBadRulesSettings    `json:"bad_rules,omitempty"`             // state
	Datapoints          []ChartTextWidgetDatapoint       `json:"datapoints,omitempty"`            // charts, text
	ContactGroups       []uint                           `json:"contact_groups,omitempty"`        // alerts
	OffHours            []uint                           `json:"off_hours,omitempty"`             // alerts
	KeySize             uint                             `json:"key_size,omitempty"`              // graphs
	Limit               uint                             `json:"limit,omitempty"`                 // lists
	Period              uint                             `json:"period,omitempty"`                // gauges, text, graphs
	ClusterID           uint                             `json:"cluster_id,omitempty"`            // clusters
	Threshold           float32                          `json:"threshold,omitempty"`             // clusters
	KeyWrap             bool                             `json:"key_wrap,omitempty"`              // graphs
	KeyInline           bool                             `json:"key_inline,omitempty"`            // graphs
	DisableAutoformat   bool                             `json:"disable_autoformat,omitempty"`    // gauges
	HideXAxis           bool                             `json:"hide_xaxis,omitempty"`            // graphs
	HideYAxis           bool                             `json:"hide_yaxis,omitempty"`            // graphs
	Realtime            bool                             `json:"realtime,omitempty"`              // graphs
	ShowFlags           bool                             `json:"show_flags,omitempty"`            // graphs
	UseDefault          bool                             `json:"use_default,omitempty"`           // text
	Autoformat          bool                             `json:"autoformat,omitempty"`            // text
}

type ForecastGaugeWidgetThresholds struct {
	Colors []string `json:"colors,omitempty"` // forecasts, gauges
	Values []string `json:"values,omitempty"` // forecasts, gauges
	Flip   bool     `json:"flip"`             // gauges 2019-11-01, flip is required
}

type Graph struct {
	LineStyle      *string                     `json:"line_style"`          // string or null
	Style          *string                     `json:"style"`               // string or null
	Notes          *string                     `json:"notes"`               // string or null
	OverlaySets    *map[string]GraphOverlaySet `json:"overlay_sets"`        // GroupOverLaySets or null
	CID            string                      `json:"_cid"`                // string
	Description    string                      `json:"description"`         // string
	Title          string                      `json:"title"`               // string
	LogLeftY       interface{}                 `json:"logarithmic_left_y"`  // string that must parse to an int, empty string "", or null BUG doc: number (not string)
	LogRightY      interface{}                 `json:"logarithmic_right_y"` // string that must parse to a float, empty string "", or null BUG doc: number (not string)
	MaxLeftY       interface{}                 `json:"max_left_y"`          // string that must parse to a float, empty string "", or null BUG doc: number (not string)
	MaxRightY      interface{}                 `json:"max_right_y"`         // string that must parse to a float, empty string "", or null BUG doc: number (not string)
	MinLeftY       interface{}                 `json:"min_left_y"`          // string that must parse to a float, empty string "", or null BUG doc: number (not string)
	MinRightY      interface{}                 `json:"min_right_y"`         // string that must parse to a float, empty string "", or null BUG doc: number (not string)
	Tags           []string                    `json:"tags"`                // [] len >= 0
	AccessKeys     []GraphAccessKey            `json:"access_keys"`         // [] len >= 0
	Composites     []GraphComposite            `json:"composites"`          // [] len >= 0
	Datapoints     []GraphDatapoint            `json:"datapoints"`          // [] len >= 0
	Guides         []GraphGuide                `json:"guides"`              // [] len >= 0
	MetricClusters []GraphMetricCluster        `json:"metric_clusters"`     // [] len >= 0
}

type GraphAccessKey struct {
	Key            string `json:"key,omitempty"`              // string
	LockMode       string `json:"lock_mode,omitempty"`        // string
	LockZoom       string `json:"lock_zoom,omitempty"`        // string
	Nickname       string `json:"nickname,omitempty"`         // string
	Height         uint   `json:"height,omitempty"`           // uint
	LockRangeEnd   uint   `json:"lock_range_end,omitempty"`   // uint
	LockRangeStart uint   `json:"lock_range_start,omitempty"` // uint
	Width          uint   `json:"width,omitempty"`            // uint
	Active         bool   `json:"active,omitempty"`           // boolean
	Legend         bool   `json:"legend,omitempty"`           // boolean
	LockDate       bool   `json:"lock_date,omitempty"`        // boolean
	LockShowTimes  bool   `json:"lock_show_times,omitempty"`  // boolean
	Title          bool   `json:"title,omitempty"`            // boolean
	XLabels        bool   `json:"x_labels,omitempty"`         // boolean
	YLabels        bool   `json:"y_labels,omitempty"`         // boolean
}

type GraphComposite struct {
	Stack         *uint   `json:"stack"`          // uint or null
	DataFormula   *string `json:"data_formula"`   // string or null
	LegendFormula *string `json:"legend_formula"` // string or null
	Axis          string  `json:"axis"`           // string
	Color         string  `json:"color"`          // string
	Name          string  `json:"name"`           // string
	Hidden        bool    `json:"hidden"`         // boolean
}

type GraphDatapoint struct {
	Derive        interface{} `json:"derive,omitempty"`      // BUG doc: string, api: string or boolean(for caql statements)
	Search        *string     `json:"search"`                // string or null
	Alpha         *string     `json:"alpha,omitempty"`       // BUG: doc: floating point number, api: string
	CAQL          *string     `json:"caql,omitempty"`        // string or null
	Color         *string     `json:"color,omitempty"`       // string
	DataFormula   *string     `json:"data_formula"`          // string or null
	LegendFormula *string     `json:"legend_formula"`        // string or null
	Stack         *uint       `json:"stack"`                 // uint or null
	Axis          string      `json:"axis,omitempty"`        // string
	MetricName    string      `json:"metric_name,omitempty"` // string
	MetricType    string      `json:"metric_type,omitempty"` // string
	Name          string      `json:"name"`                  // string
	CheckID       uint        `json:"check_id,omitempty"`    // uint
	Hidden        bool        `json:"hidden"`                // boolean
}

type GraphGuide struct {
	DataFormula   *string `json:"data_formula"`   // string or null
	LegendFormula *string `json:"legend_formula"` // string or null
	Color         string  `json:"color"`          // string
	Name          string  `json:"name"`           // string
	Hidden        bool    `json:"hidden"`         // boolean
}

type GraphMetricCluster struct {
	Color         *string `json:"color,omitempty"`              // string
	DataFormula   *string `json:"data_formula"`                 // string or null
	LegendFormula *string `json:"legend_formula"`               // string or null
	Stack         *uint   `json:"stack"`                        // uint or null
	MetricCluster string  `json:"metric_cluster,omitempty"`     // string
	Name          string  `json:"name,omitempty"`               // string
	AggregateFunc string  `json:"aggregate_function,omitempty"` // string
	Axis          string  `json:"axis,omitempty"`               // string
	Hidden        bool    `json:"hidden"`                       // boolean
}

type GraphOverlay struct {
	DataOpts OverlayDataOptions `json:"data_opts,omitempty"` // OverlayDataOptions
	ID       string             `json:"id,omitempty"`        // string
	Title    string             `json:"title,omitempty"`     // string
	UISpecs  OverlayUISpecs     `json:"ui_specs,omitempty"`  // OverlayUISpecs
}

type GraphOverlaySet struct {
	Overlays map[string]GraphOverlay `json:"overlays"`
	Title    string                  `json:"title"`
}

type IDType int

type Logger interface {
	Printf(string, ...interface{})
}

type Maintenance struct {
	Severities interface{} `json:"severities,omitempty"` // []string NOTE can be set with CSV string or []string
	CID        string      `json:"_cid,omitempty"`       // string
	Item       string      `json:"item,omitempty"`       // string
	Notes      string      `json:"notes,omitempty"`      // string
	Type       string      `json:"type,omitempty"`       // string
	Tags       []string    `json:"tags,omitempty"`       // [] len >= 0
	Start      uint        `json:"start,omitempty"`      // uint
	Stop       uint        `json:"stop,omitempty"`       // uint
}

type Metric struct {
	Notes          *string  `json:"notes,omitempty"`         // string or null
	Link           *string  `json:"link,omitempty"`          // string or null
	CheckBundleCID string   `json:"_check_bundle,omitempty"` // string
	CheckCID       string   `json:"_check,omitempty"`        // string
	CheckUUID      string   `json:"_check_uuid,omitempty"`   // string
	CID            string   `json:"_cid,omitempty"`          // string
	Histogram      string   `json:"_histogram,omitempty"`    // string
	MetricName     string   `json:"_metric_name,omitempty"`  // string
	MetricType     string   `json:"_metric_type,omitempty"`  // string
	CheckTags      []string `json:"_check_tags,omitempty"`   // [] len >= 0
	Active         bool     `json:"_active,omitempty"`       // boolean
	CheckActive    bool     `json:"_check_active,omitempty"` // boolean

}

type MetricCluster struct {
	CID                 string              `json:"_cid,omitempty"`                   // string
	Description         string              `json:"description"`                      // string
	MatchingMetrics     []string            `json:"_matching_metrics,omitempty"`      // [] len >= 1 (result info only, if query has extras - cannot be set)
	MatchingUUIDMetrics map[string][]string `json:"_matching_uuid_metrics,omitempty"` // [] len >= 1 (result info only, if query has extras - cannot be set)
	Name                string              `json:"name"`                             // string
	Queries             []MetricQuery       `json:"queries"`                          // [] len >= 1
	Tags                []string            `json:"tags"`                             // [] len >= 0
}

type MetricQuery struct {
	Query string `json:"query"`
	Type  string `json:"type"`
}

type OutlierReport struct {
	CID              string   `json:"_cid,omitempty"`              // string
	Config           string   `json:"config,omitempty"`            // string
	CreatedBy        string   `json:"_created_by,omitempty"`       // string
	LastModifiedBy   string   `json:"_last_modified_by,omitempty"` // string
	MetricClusterCID string   `json:"metric_cluster,omitempty"`    // st ring
	Title            string   `json:"title,omitempty"`             // string
	Tags             []string `json:"tags,omitempty"`              // [] len >= 0
	Created          uint     `json:"_created,omitempty"`          // uint
	LastModified     uint     `json:"_last_modified,omitempty"`    // uint
}

type OverlayDataOptions struct {
	Alerts        string `json:"alerts,omitempty"`         // int encoded as string BUG doc: numeric, api: string
	ArrayOutput   string `json:"array_output,omitempty"`   // int encoded as string BUG doc: numeric, api: string
	BasePeriod    string `json:"base_period,omitempty"`    // int encoded as string BUG doc: numeric, api: string
	Delay         string `json:"delay,omitempty"`          // int encoded as string BUG doc: numeric, api: string
	Extension     string `json:"extension,omitempty"`      // string
	GraphTitle    string `json:"graph_title,omitempty"`    // string
	GraphUUID     string `json:"graph_id,omitempty"`       // string
	InPercent     string `json:"in_percent,omitempty"`     // boolean encoded as string BUG doc: boolean, api: string
	Inverse       string `json:"inverse,omitempty"`        // int encoded as string BUG doc: numeric, api: string
	Method        string `json:"method,omitempty"`         // string
	Model         string `json:"model,omitempty"`          // string
	ModelEnd      string `json:"model_end,omitempty"`      // string
	ModelPeriod   string `json:"model_period,omitempty"`   // string
	ModelRelative string `json:"model_relative,omitempty"` // int encoded as string BUG doc: numeric, api: string
	Out           string `json:"out,omitempty"`            // string
	Prequel       string `json:"prequel,omitempty"`        // int
	Presets       string `json:"presets,omitempty"`        // string
	Quantiles     string `json:"quantiles,omitempty"`      // string
	SeasonLength  string `json:"season_length,omitempty"`  // int encoded as string BUG doc: numeric, api: string
	Sensitivity   string `json:"sensitivity,omitempty"`    // int encoded as string BUG doc: numeric, api: string
	SingleValue   string `json:"single_value,omitempty"`   // int encoded as string BUG doc: numeric, api: string
	TargetPeriod  string `json:"target_period,omitempty"`  // string
	TimeOffset    string `json:"time_offset,omitempty"`    // string
	TimeShift     string `json:"time_shift,omitempty"`     // int encoded as string BUG doc: numeric, api: string
	Transform     string `json:"transform,omitempty"`      // string
	Version       string `json:"version,omitempty"`        // int encoded as string BUG doc: numeric, api: string
	Window        string `json:"window,omitempty"`         // int encoded as string BUG doc: numeric, api: string
	XShift        string `json:"x_shift,omitempty"`        // string
}

type OverlayUISpecs struct {
	ID       string `json:"id,omitempty"`       // string
	Label    string `json:"label,omitempty"`    // string
	Type     string `json:"type,omitempty"`     // string
	Z        string `json:"z,omitempty"`        // int encoded as string BUG doc: numeric, api: string
	Decouple bool   `json:"decouple,omitempty"` // boolean
}

type ProvisionBroker struct {
	Cert                    string           `json:"_cert,omitempty"`                     // string
	CID                     string           `json:"_cid,omitempty"`                      // string
	CSR                     string           `json:"_csr,omitempty"`                      // string
	ExternalHost            string           `json:"external_host,omitempty"`             // string
	ExternalPort            string           `json:"external_port,omitempty"`             // string
	IPAddress               string           `json:"ipaddress,omitempty"`                 // string
	Latitude                string           `json:"latitude,omitempty"`                  // string
	Longitude               string           `json:"longitude,omitempty"`                 // string
	Name                    string           `json:"noit_name,omitempty"`                 // string
	Port                    string           `json:"port,omitempty"`                      // string
	Stratcons               []BrokerStratcon `json:"_stratcons,omitempty"`                // [] len >= 1
	Tags                    []string         `json:"tags,omitempty"`                      // [] len >= 0
	PreferReverseConnection bool             `json:"prefer_reverse_connection,omitempty"` // boolean
	Rebuild                 bool             `json:"rebuild,omitempty"`                   // boolean
}

type RuleSet struct {
	CID           string             `json:"_cid,omitempty"`           // string
	Host          string             `json:"_host,omitempty"`          // string
	CheckCID      string             `json:"check"`                    // string
	ContactGroups map[uint8][]string `json:"contact_groups"`           // [] len 5
	Filter        string             `json:"filter,omitempty"`         // string
	Link          *string            `json:"link"`                     // string or null
	LookupKey     *string            `json:"lookup_key"`               // string or null
	MetricName    string             `json:"metric_name,omitempty"`    // string (name or pattern)
	MetricPattern string             `json:"metric_pattern,omitempty"` // string (name or pattern)
	MetricTags    []string           `json:"metric_tags"`              // [] len >= 0
	MetricType    string             `json:"metric_type"`              // string
	Name          string             `json:"name,omitempty"`           // string
	Notes         *string            `json:"notes"`                    // string or null
	UserJSON      json.RawMessage    `json:"user_json,omitempty"`      // // abitrary json the ruleset creator supplies.. this is opaque and only has to be parseable JSON <= 4096 chars
	Parent        *string            `json:"parent,omitempty"`         // string or null
	Rules         []RuleSetRule      `json:"rules"`                    // [] len >= 1
	Tags          []string           `json:"tags"`                     // [] len >= 0
}

type RuleSetGroup struct {
	CID               string                  `json:"_cid,omitempty"`      // string
	Name              string                  `json:"name"`                // string
	Tags              []string                `json:"tags"`                // [] len >= 0
	ContactGroups     map[uint8][]string      `json:"contact_groups"`      // [] len == 5
	Formulas          []RuleSetGroupFormula   `json:"formulas"`            // [] len >= 0
	RuleSetConditions []RuleSetGroupCondition `json:"rule_set_conditions"` // [] len >= 1
}

type RuleSetGroupCondition struct {
	RuleSetCID         string   `json:"rule_set"`            // string
	MatchingSeverities []string `json:"matching_severities"` // [] len >= 1
}

type RuleSetGroupFormula struct {
	Expression    interface{} `json:"expression"`     // string or uint BUG doc: string, api: string or numeric
	RaiseSeverity interface{} `json:"raise_severity"` // string or uint BUG doc: numeric, api: string or numeric
	Wait          uint        `json:"wait"`           // uint
}

type RuleSetRule struct {
	Value                interface{} `json:"value"`                            // BUG doc: string, api: actual type returned switches based on Criteria
	WindowingFunction    *string     `json:"windowing_function,omitempty"`     // string or null
	Criteria             string      `json:"criteria"`                         // string
	Severity             uint        `json:"severity"`                         // uint
	Wait                 uint        `json:"wait"`                             // uint
	WindowingDuration    uint        `json:"windowing_duration,omitempty"`     // uint
	WindowingMinDuration uint        `json:"windowing_min_duration,omitempty"` // uint
}

type SearchFilterType map[string][]string

type SearchQueryType string

type StateWidgetBadRulesSettings struct {
	Value     string `json:"value,omitempty"`
	Criterion string `json:"criterion,omitempty"`
	Color     string `json:"color,omitempty"`
}

type StatusWidgetAgentStatusSettings struct {
	Search         string `json:"search,omitempty"`
	ShowAgentTypes string `json:"show_agent_types,omitempty"`
	ShowContact    bool   `json:"show_contact,omitempty"`
	ShowFeeds      bool   `json:"show_feeds,omitempty"`
	ShowSetup      bool   `json:"show_setup,omitempty"`
	ShowSkew       bool   `json:"show_skew,omitempty"`
	ShowUpdates    bool   `json:"show_updates,omitempty"`
}

type StatusWidgetHostStatusSettings struct {
	LayoutStyle  string   `json:"layout_style,omitempty"`
	Search       string   `json:"search,omitempty"`
	SortBy       string   `json:"sort_by,omitempty"`
	TagFilterSet []string `json:"tag_filter_set,omitempty"`
}

type TagType []string

type TokenAccountIDType string

type TokenAppType string

type TokenKeyType string

type URLType string

type User struct {
	CID         string          `json:"_cid,omitempty"`         // string
	ContactInfo UserContactInfo `json:"contact_info,omitempty"` // UserContactInfo
	Email       string          `json:"email"`                  // string
	Firstname   string          `json:"firstname"`              // string
	Lastname    string          `json:"lastname"`               // string
}

type UserContactInfo struct {
	SMS  string `json:"sms,omitempty"`  // string
	XMPP string `json:"xmpp,omitempty"` // string
}

type Worksheet struct {
	Notes        *string               `json:"notes"`                   // string or null
	Description  *string               `json:"description"`             // string or null
	CID          string                `json:"_cid,omitempty"`          // string
	Title        string                `json:"title"`                   // string
	Tags         []string              `json:"tags"`                    // [] len >= 0
	Graphs       []WorksheetGraph      `json:"graphs"`                  // [] len >= 0
	SmartQueries []WorksheetSmartQuery `json:"smart_queries,omitempty"` // [] len >= 0
	Favorite     bool                  `json:"favorite"`                // boolean
}

type WorksheetGraph struct {
	GraphCID string `json:"graph"` // string
}

type WorksheetSmartQuery struct {
	Name  string   `json:"name"`
	Query string   `json:"query"`
	Order []string `json:"order"`
}