courier

type ConfigProvider interface {
	CourierConfig() config.CourierConfigs
}

type Courier interface {
	Work(ctx context.Context) error
	QueueEmail(ctx context.Context, t EmailTemplate) (uuid.UUID, error)
	QueueSMS(ctx context.Context, t SMSTemplate) (uuid.UUID, error)
	SmtpDialer() *gomail.Dialer
	DispatchQueue(ctx context.Context) error
	DispatchMessage(ctx context.Context, msg Message) error
	SetGetEmailTemplateType(f func(t EmailTemplate) (TemplateType, error))
	SetNewEmailTemplateFromMessage(f func(d template.Dependencies, msg Message) (EmailTemplate, error))
	UseBackoff(b backoff.BackOff)
}

type CourierMessageDispatchStatus string

type Dependencies interface {
	PersistenceProvider
	x.LoggingProvider
	ConfigProvider
	x.HTTPClientProvider
	jsonnetsecure.VMProvider
}

type EmailTemplate interface {
	json.Marshaler
	EmailSubject(context.Context) (string, error)
	EmailBody(context.Context) (string, error)
	EmailBodyPlaintext(context.Context) (string, error)
	EmailRecipient() (string, error)
}

type Handler struct {
	// contains filtered or unexported fields
}

type HandlerProvider interface {
	CourierHandler() *Handler
}

type ListCourierMessagesParameters struct {
	keysetpagination.RequestParameters

	// Status filters out messages based on status.
	// If no value is provided, it doesn't take effect on filter.
	//
	// required: false
	// in: query
	Status *MessageStatus `json:"status"`

	// Recipient filters out messages based on recipient.
	// If no value is provided, it doesn't take effect on filter.
	//
	// required: false
	// in: query
	Recipient string `json:"recipient"`
}

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 TemplateType `json:"template_type" db:"template_type"`

	TemplateData []byte `json:"-" db:"template_data"`
	// 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"`
}

type MessageDispatch struct {
	// The ID of this message dispatch
	// required: true
	ID uuid.UUID `json:"id" db:"id"`

	// The ID of the message being dispatched
	// required: true
	MessageID uuid.UUID `json:"message_id" db:"message_id"`

	// The status of this dispatch
	// Either "failed" or "success"
	// required: true
	Status CourierMessageDispatchStatus `json:"status" db:"status"`

	// An optional error
	Error sqlxx.JSONRawMessage `json:"error,omitempty" db:"error"`

	// CreatedAt is a helper struct field for gobuffalo.pop.
	// required: true
	CreatedAt time.Time `json:"created_at" db:"created_at"`
	// UpdatedAt is a helper struct field for gobuffalo.pop.
	// required: true
	UpdatedAt time.Time `json:"updated_at" db:"updated_at"`

	NID uuid.UUID `json:"-" db:"nid"`
}

type MessageStatus int

type MessageType int

type PersistenceProvider interface {
	CourierPersister() Persister
}

type Persister interface {
	AddMessage(context.Context, *Message) error

	NextMessages(context.Context, uint8) ([]Message, error)

	SetMessageStatus(context.Context, uuid.UUID, MessageStatus) error

	LatestQueuedMessage(ctx context.Context) (*Message, error)

	IncrementMessageSendCount(context.Context, uuid.UUID) error

	// ListMessages lists all messages in the store given the page, itemsPerPage, status and recipient.
	// Returns list of messages, total count of messages satisfied by given filter, and error if any
	ListMessages(context.Context, ListCourierMessagesParameters, []keysetpagination.Option) ([]Message, int64, *keysetpagination.Paginator, error)

	// FetchMessage returns a message with the id or nil and an error if not found
	FetchMessage(context.Context, uuid.UUID) (*Message, error)

	// Records an attempt of sending out a courier message
	// Returns an error if it fails
	RecordDispatch(ctx context.Context, msgID uuid.UUID, status CourierMessageDispatchStatus, err error) error
}

type Provider interface {
	Courier(ctx context.Context) (Courier, error)
}

type SMSTemplate interface {
	json.Marshaler
	SMSBody(context.Context) (string, error)
	PhoneNumber() (string, error)
}

type TemplateType string