models

type Action struct {
	Channel   ChannelReference `json:"channel" validate:"required"`
	Recipient string           `json:"recipient,omitempty"` // specific recipient if supported/required by the channel, e.g. for mail a comma separated list of mail adresses
}

type ChannelReference struct {
	ID   string      `json:"id" validate:"required"`
	Name string      `json:"name" readonly:"true"`
	Type ChannelType `json:"type" readonly:"true"`
}

type ChannelType string

type Notification struct {
	Id               string              `json:"id" readonly:"true"`
	Origin           string              `json:"origin" binding:"required"`  // name of the origin, e.g. `SBOM - React`
	OriginClass      string              `json:"originClass"`                // unique identifier for the class of origins, e.g. `/vi/SBOM`, for now optional for backwards compatibility, will be required in future
	OriginResourceID string              `json:"originResourceID,omitempty"` // together with class it can be used to provide a link to the origin, e.g. `<id of react sbom object>`
	Timestamp        string              `json:"timestamp" binding:"required" format:"date-time"`
	Title            string              `json:"title" binding:"required"`
	Detail           string              `json:"detail" binding:"required"`
	Level            notifications.Level `json:"level" binding:"required" enums:"info,warning,error,urgent"`
	CustomFields     map[string]any      `json:"customFields,omitempty"` // can contain arbitrary structured information about the event
}

type NotificationChannel struct {
	Id                       *string     `json:"id" readonly:"true"`
	CreatedAt                string      `json:"createdAt" readonly:"true"`
	UpdatedAt                *string     `json:"updatedAt,omitempty"`
	ChannelType              ChannelType `json:"channelType" binding:"required"`
	ChannelName              *string     `json:"channelName,omitempty"`
	WebhookUrl               *string     `json:"webhookUrl,omitempty"`
	Description              *string     `json:"description,omitempty"`
	Domain                   *string     `json:"domain,omitempty"`
	Port                     *int        `json:"port,omitempty"`
	IsAuthenticationRequired *bool       `json:"isAuthenticationRequired,omitempty"`
	IsTlsEnforced            *bool       `json:"isTlsEnforced,omitempty"`
	Username                 *string     `json:"username,omitempty"`
	Password                 *string     `json:"password,omitempty"`
	MaxEmailAttachmentSizeMb *int        `json:"maxEmailAttachmentSizeMb,omitempty"`
	MaxEmailIncludeSizeMb    *int        `json:"maxEmailIncludeSizeMb,omitempty"`
	SenderEmailAddress       *string     `json:"senderEmailAddress,omitempty"`
}

type Origin struct {
	Name      string `json:"name" validate:"required"`  // human readable name representation
	Class     string `json:"class" validate:"required"` // unique identifier
	ServiceID string `json:"serviceID" readonly:"true"` // service in which this origin is defined
}

type OriginList []Origin

type OriginReference struct {
	Name      string `json:"name" readonly:"true"`
	Class     string `json:"class" validate:"required"`
	ServiceID string `json:"serviceID" readonly:"true"`
}

type Rule struct {
	ID      string           `json:"id" readonly:"true"`
	Name    string           `json:"name" validate:"required"`
	Trigger Trigger          `json:"trigger" validate:"required"`
	Action  Action           `json:"action" validate:"required"`
	Active  bool             `json:"active"`
	Errors  ValidationErrors `json:"errors,omitempty" readonly:"true"` // populated if the rule is invalid, this can be useful to highlight rules which need action from the user.
}

type RuleOptionChannel struct {
	Id           *string     `json:"id" readonly:"true"`
	ChannelType  ChannelType `json:"channelType" binding:"required"`
	ChannelName  *string     `json:"channelName,omitempty"`
	HasRecipient bool        `json:"hasRecipient"`
}

type RuleOptions struct {
	Origins  []OriginReference     `json:"origins"`
	Levels   []notifications.Level `json:"levels"`
	Channels []RuleOptionChannel   `json:"channels"`
}

type Trigger struct {
	Origins []OriginReference     `json:"origins" validate:"required"`
	Levels  []notifications.Level `json:"levels" validate:"required"`
}

type ValidationErrors map[string]string