models

package
v0.11.1-alpha1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 22, 2026 License: AGPL-3.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChannelType added in v0.12.0

type ChannelType string
const (
	ChannelTypeMail       ChannelType = "mail"
	ChannelTypeMattermost ChannelType = "mattermost"
	ChannelTypeTeams      ChannelType = "teams"
)

type Notification

type Notification struct {
	Id           string         `json:"id" readonly:"true"`
	Origin       string         `json:"origin" binding:"required"`
	OriginUri    string         `json:"originUri,omitempty"` // can be used to provide a link to the origin
	Timestamp    string         `json:"timestamp" binding:"required" format:"date-time"`
	Title        string         `json:"title" binding:"required"` // can also be seen as the 'type'
	Detail       string         `json:"detail" binding:"required"`
	Level        string         `json:"level" binding:"required" enums:"info,warning,error"`
	CustomFields map[string]any `json:"customFields,omitempty"` // can contain arbitrary structured information about the notification
}

type NotificationChannel added in v0.12.0

type NotificationChannel struct {
	Id                       *string `json:"id" readonly:"true"`
	CreatedAt                string  `json:"createdAt" readonly:"true"`
	UpdatedAt                *string `json:"updatedAt,omitempty"`
	ChannelType              string  `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"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL