api

Documentation

Index

• func Setup()
• type API
  • func (API) DeliverAlert(ctx context.Context, input *deliverymodel.DeliverAlertInput) (*deliverymodel.DeliverAlertOutput, error)
  • func (API) DispatchAlerts(ctx context.Context, input []*deliverymodel.DispatchAlertsInput) (interface{}, error)
  • func (API) SendTestAlert(ctx context.Context, input *deliverymodel.SendTestAlertInput) ([]*deliverymodel.SendTestAlertOutput, error)
• type AlertOutputMap
• type DispatchStatus

Functions

func Setup

func Setup()

Setup - initialize global state

Types

type API

type API struct{}

API has all of the handlers as receiver methods.

func (API) DeliverAlert

func (API) DeliverAlert(ctx context.Context, input *deliverymodel.DeliverAlertInput) (*deliverymodel.DeliverAlertOutput, error)

DeliverAlert sends a specific alert to the specified destinations.

func (API) DispatchAlerts

func (API) DispatchAlerts(ctx context.Context, input []*deliverymodel.DispatchAlertsInput) (interface{}, error)

DispatchAlerts - Sends an alert to sends a specific alert to the specified destinations.

func (API) SendTestAlert

func (API) SendTestAlert(ctx context.Context, input *deliverymodel.SendTestAlertInput) ([]*deliverymodel.SendTestAlertOutput, error)

SendTestAlert sends a dummy alert to the specified destinations.

type AlertOutputMap

type AlertOutputMap map[*deliverymodel.Alert][]*outputModels.AlertOutput

AlertOutputMap is a type alias for containing the outputIds that an alert should be delivered to

type DispatchStatus

type DispatchStatus struct {
	Alert        deliverymodel.Alert
	OutputID     string
	Message      string
	StatusCode   int
	Success      bool
	NeedsRetry   bool
	DispatchedAt time.Time
}

DispatchStatus holds info about which alert was sent to a given destination with its response status