snapshot of https://github.com/ory/kratos.git (master, 2026-09-15; blobs > 131072B omitted)

courier/message.go

@@ -0,0 +1,226 @@
+// Copyright © 2023 Ory Corp
+// SPDX-License-Identifier: Apache-2.0
+
+package courier
+
+import (
+	"encoding/json"
+	"time"
+
+	"github.com/gofrs/uuid"
+	"github.com/pkg/errors"
+
+	"github.com/ory/herodot"
+	"github.com/ory/kratos/courier/template"
+	keysetpagination "github.com/ory/x/pagination/keysetpagination_v2"
+	"github.com/ory/x/sqlxx"
+	"github.com/ory/x/stringsx"
+)
+
+// A Message's Status
+//
+// swagger:model courierMessageStatus
+type MessageStatus int
+
+const (
+	MessageStatusQueued MessageStatus = iota + 1
+	MessageStatusSent
+	MessageStatusProcessing
+	MessageStatusAbandoned
+)
+
+const (
+	messageStatusQueuedText     = "queued"
+	messageStatusSentText       = "sent"
+	messageStatusProcessingText = "processing"
+	messageStatusAbandonedText  = "abandoned"
+)
+
+func ToMessageStatus(str string) (MessageStatus, error) {
+	switch s := stringsx.SwitchExact(str); {
+	case s.AddCase(MessageStatusQueued.String()):
+		return MessageStatusQueued, nil
+	case s.AddCase(MessageStatusSent.String()):
+		return MessageStatusSent, nil
+	case s.AddCase(MessageStatusProcessing.String()):
+		return MessageStatusProcessing, nil
+	case s.AddCase(MessageStatusAbandoned.String()):
+		return MessageStatusAbandoned, nil
+	default:
+		return 0, errors.WithStack(herodot.ErrBadRequest().WithWrap(s.ToUnknownCaseErr()).WithReason("Message status is not valid"))
+	}
+}
+
+func (ms MessageStatus) String() string {
+	switch ms {
+	case MessageStatusQueued:
+		return messageStatusQueuedText
+	case MessageStatusSent:
+		return messageStatusSentText
+	case MessageStatusProcessing:
+		return messageStatusProcessingText
+	case MessageStatusAbandoned:
+		return messageStatusAbandonedText
+	default:
+		return ""
+	}
+}
+
+func (ms MessageStatus) IsValid() error {
+	switch ms {
+	case MessageStatusQueued, MessageStatusSent, MessageStatusProcessing, MessageStatusAbandoned:
+		return nil
+	default:
+		return errors.WithStack(herodot.ErrBadRequest().WithReason("Message status is not valid"))
+	}
+}
+
+func (ms MessageStatus) MarshalJSON() ([]byte, error) {
+	if err := ms.IsValid(); err != nil {
+		return nil, err
+	}
+	return json.Marshal(ms.String())
+}
+
+func (ms *MessageStatus) UnmarshalJSON(data []byte) error {
+	var str string
+	if err := json.Unmarshal(data, &str); err != nil {
+		return err
+	}
+
+	s, err := ToMessageStatus(str)
+	if err != nil {
+		return err
+	}
+
+	*ms = s
+	return nil
+}
+
+// A Message's Type
+//
+// It can either be `email` or `phone`
+//
+// swagger:model courierMessageType
+type MessageType int
+
+const (
+	MessageTypeEmail MessageType = iota + 1
+	MessageTypeSMS
+)
+
+const (
+	messageTypeEmailText = "email"
+	messageTypeSMSText   = "sms"
+)
+
+func ToMessageType(str string) (MessageType, error) {
+	switch s := stringsx.SwitchExact(str); {
+	case s.AddCase(messageTypeEmailText):
+		return MessageTypeEmail, nil
+	case s.AddCase(messageTypeSMSText):
+		return MessageTypeSMS, nil
+	default:
+		return 0, errors.WithStack(herodot.ErrBadRequest().WithWrap(s.ToUnknownCaseErr()).WithReason("Message type is not valid"))
+	}
+}
+
+func (mt MessageType) String() string {
+	switch mt {
+	case MessageTypeEmail:
+		return messageTypeEmailText
+	case MessageTypeSMS:
+		return messageTypeSMSText
+	default:
+		return ""
+	}
+}
+
+func (mt MessageType) IsValid() error {
+	switch mt {
+	case MessageTypeEmail, MessageTypeSMS:
+		return nil
+	default:
+		return errors.WithStack(herodot.ErrBadRequest().WithReason("Message type is not valid"))
+	}
+}
+
+func (mt MessageType) MarshalJSON() ([]byte, error) {
+	if err := mt.IsValid(); err != nil {
+		return nil, err
+	}
+	return json.Marshal(mt.String())
+}
+
+func (mt *MessageType) UnmarshalJSON(data []byte) error {
+	var str string
+	if err := json.Unmarshal(data, &str); err != nil {
+		return err
+	}
+
+	t, err := ToMessageType(str)
+	if err != nil {
+		return err
+	}
+
+	*mt = t
+	return nil
+}
+
+// swagger:model message
+type Message struct {
+	// required: true
+	ID uuid.UUID `json:"id" faker:"-" db:"id"`
+
+	NID uuid.UUID `json:"-" faker:"-" db:"nid"`
+	// required: true
+	Status MessageStatus `json:"status" db:"status"`
+	// required: true
+	Type MessageType `json:"type" db:"type"`
+	// required: true
+	Recipient string `json:"recipient" db:"recipient"`
+	// required: true
+	Body string `json:"body" db:"body"`
+	// required: true
+	Subject string `json:"subject" db:"subject"`
+	// required: true
+	TemplateType template.TemplateType `json:"template_type" db:"template_type"`
+
+	Channel sqlxx.NullString `json:"channel" db:"channel"`
+
+	TemplateData   []byte `json:"-" db:"template_data"`
+	RequestHeaders []byte `json:"-" faker:"-" db:"request_headers"`
+	// required: true
+	SendCount int `json:"send_count" db:"send_count"`
+
+	// Dispatches store information about the attempts of delivering a message
+	// May contain an error if any happened, or just the `success` state.
+	Dispatches []MessageDispatch `json:"dispatches,omitempty" has_many:"courier_message_dispatches" order_by:"created_at desc" faker:"-"`
+
+	// CreatedAt is a helper struct field for gobuffalo.pop.
+	// required: true
+	CreatedAt time.Time `json:"created_at" faker:"-" db:"created_at"`
+	// UpdatedAt is a helper struct field for gobuffalo.pop.
+	// required: true
+	UpdatedAt time.Time `json:"updated_at" faker:"-" db:"updated_at"`
+}
+
+func (m Message) PageToken() keysetpagination.PageToken {
+	return keysetpagination.NewPageToken(
+		keysetpagination.Column{
+			Name:  "created_at",
+			Order: keysetpagination.OrderDescending,
+			Value: m.CreatedAt,
+		}, keysetpagination.Column{
+			Name:  "id",
+			Value: m.ID,
+		},
+	)
+}
+
+func (m Message) DefaultPageToken() keysetpagination.PageToken {
+	return Message{ID: uuid.Nil, CreatedAt: time.Date(2200, 12, 31, 23, 59, 59, 0, time.UTC)}.PageToken()
+}
+
+func (m Message) TableName() string { return "courier_messages" }
+func (m *Message) GetID() uuid.UUID { return m.ID }