nfymsg

type Alert struct {
	Base

	AlertID     int // The global alert number
	Summary     string
	Details     string
	ServiceID   string
	ServiceName string
	Meta        map[string]string

	// OriginalStatus is the status of the first Alert notification to this Dest for this AlertID.
	OriginalStatus *SendResult
}

type AlertBundle struct {
	Base

	ServiceID   string
	ServiceName string // The service being notified for
	Count       int    // Number of unacked alerts
}

type AlertState int

type AlertStatus struct {
	Base

	AlertID   int
	LogEntry  string
	ServiceID string

	// Summary of the alert that this status is in regards to.
	Summary string
	// Details of the alert that this status is in regards to.
	Details string

	// OriginalStatus is the status of the first Alert notification to this Dest for this AlertID.
	OriginalStatus SendResult

	// NewAlertState contains the most recent state of the alert.
	NewAlertState AlertState
}

type Base struct {
	ID   string
	Dest gadb.DestV1
}

type Message interface {
	MsgID() string
	DestType() string
	DestArg(name string) string
}

type ScheduleOnCallUsers struct {
	Base

	ScheduleID   string
	ScheduleName string
	ScheduleURL  string

	Users []User
}

type SendResult struct {
	// ID is the GoAlert message ID.
	ID string

	// ProviderMessageID is an identifier that represents the provider-specific ID
	// of the message (e.g. Twilio SID).
	ProviderMessageID gadb.ProviderMessageID

	Status

	DestType string
}

type SentMessage struct {
	ExternalID   string
	State        State
	StateDetails string
	SrcValue     string
}

type SignalMessage struct {
	Base

	Params map[string]string
}

type State int

type Status struct {
	// State is the current state.
	State State

	// Details can contain any additional information about the State (e.g. "ringing", "no-answer" etc..).
	Details string

	// Sequence can be used when the provider sends updates out-of order (e.g. Twilio).
	// The Sequence number defaults to 0, and a status update is ignored unless its
	// Sequence number is >= the current one.
	Sequence int

	// SrcValue can be used to set/update the source value of the message.
	SrcValue string

	// Age is the time since the message was first sent. Ignored for new messages.
	Age time.Duration
}

type Test struct {
	Base
}

type User struct {
	ID   string
	Name string
	URL  string
}

type Verification struct {
	Base
	Code string
}