contact_field_changed.go

package events

import (
	"github.com/nyaruka/goflow/assets"
	"github.com/nyaruka/goflow/flows"
)

func init() {
	registerType(TypeContactFieldChanged, func() flows.Event { return &ContactFieldChangedEvent{} })
}

// TypeContactFieldChanged is the type of our save to contact event
const TypeContactFieldChanged string = "contact_field_changed"

// ContactFieldChangedEvent events are created when a custom field value of the contact has been changed.
// A null values indicates that the field value has been cleared.
//
//   {
//     "type": "contact_field_changed",
//     "created_on": "2006-01-02T15:04:05Z",
//     "field": {"key": "gender", "name": "Gender"},
//     "value": {"text": "Male"}
//   }
//
// @event contact_field_changed
type ContactFieldChangedEvent struct {
	baseEvent

	Field *assets.FieldReference `json:"field" validate:"required"`
	Value *flows.Value           `json:"value"`
}

// NewContactFieldChanged returns a new save to contact event
func NewContactFieldChanged(field *flows.Field, value *flows.Value) *ContactFieldChangedEvent {
	return &ContactFieldChangedEvent{
		baseEvent: newBaseEvent(TypeContactFieldChanged),
		Field:     field.Reference(),
		Value:     value,
	}
}