notifiers

type Notifier struct {
	ID       string
	GroupID  string
	Name     string
	Contacts []string
	Metadata map[string]any
}

type NotifierRepository interface {
	// Save persists multiple notifiers. Notifiers are saved using a transaction.
	// If one notifier fails then none will be saved.
	// Successful operation is indicated by non-nil error response.
	Save(ctx context.Context, nfs ...Notifier) ([]Notifier, error)

	// RetrieveByGroup retrieves notifiers related to a certain group,
	// identified by a given ID.
	RetrieveByGroup(ctx context.Context, groupID string, pm PageMetadata) (NotifiersPage, error)

	// RetrieveByID retrieves the notifier having the provided ID.
	RetrieveByID(ctx context.Context, id string) (Notifier, error)

	// Update performs an update to the existing notifier.
	// A non-nil error is returned to indicate operation failure.
	Update(ctx context.Context, n Notifier) error

	// Remove removes notifiers having the provided IDs.
	Remove(ctx context.Context, ids ...string) error

	// RemoveByGroup removes notifiers related to a certain group,
	// identified by a given group ID.
	RemoveByGroup(ctx context.Context, groupID string) error
}

type NotifiersPage struct {
	Total     uint64
	Notifiers []Notifier
}

type PageMetadata struct {
	Total    uint64         `json:"total,omitempty"`
	Offset   uint64         `json:"offset,omitempty"`
	Limit    uint64         `json:"limit,omitempty"`
	Order    string         `json:"order,omitempty"`
	Dir      string         `json:"dir,omitempty"`
	Name     string         `json:"name,omitempty"`
	Metadata map[string]any `json:"metadata,omitempty"`
}

type Sender interface {
	// Send method is used to send notification for the
	// received message to the provided list of receivers.
	Send(to []string, msg protomfx.Message) error

	// ValidateContacts method is used to validate contacts
	// to which notifications will be sent.
	ValidateContacts(contacts []string) error
}

type Service interface {
	// CreateNotifiers creates notifiers for a certain group identified by the group ID.
	CreateNotifiers(ctx context.Context, token, groupID string, notifiers ...Notifier) ([]Notifier, error)

	// ListNotifiersByGroup retrieves data about a subset of notifiers
	// related to a certain group, identified by the provided group ID.
	ListNotifiersByGroup(ctx context.Context, token string, groupID string, pm PageMetadata) (NotifiersPage, error)

	// ViewNotifier retrieves data about the notifier identified with the provided ID.
	ViewNotifier(ctx context.Context, token, id string) (Notifier, error)

	// UpdateNotifier updates the notifier identified by the provided ID.
	UpdateNotifier(ctx context.Context, token string, notifier Notifier) error

	// RemoveNotifiers removes notifiers identified with the provided IDs.
	RemoveNotifiers(ctx context.Context, token string, id ...string) error

	// RemoveNotifiersByGroup removes notifiers related to the specified group,
	// identified by the provided group ID.
	RemoveNotifiersByGroup(ctx context.Context, groupID string) error

	consumers.MessageConsumer
}