set_contact_status.go

package actions

import (
	"github.com/nyaruka/goflow/flows"
	"github.com/nyaruka/goflow/flows/events"
	"github.com/nyaruka/goflow/flows/modifiers"
)

func init() {
	registerType(TypeSetContactStatus, func() flows.Action { return &SetContactStatusAction{} })
}

// TypeSetContactStatus is the type for the set contact status action
const TypeSetContactStatus string = "set_contact_status"

// SetContactStatusAction can be used to update the status of the contact, e.g. to block or unblock the contact.
// A [event:contact_status_changed] event will be created with the corresponding value.
//
//   {
//     "uuid": "8eebd020-1af5-431c-b943-aa670fc74da9",
//     "type": "set_contact_status",
//     "status": "blocked"
//   }
//
// @action set_contact_status
type SetContactStatusAction struct {
	baseAction
	universalAction

	Status flows.ContactStatus `json:"status" validate:"contact_status"`
}

// NewSetContactStatus creates a new set status action
func NewSetContactStatus(uuid flows.ActionUUID, status flows.ContactStatus) *SetContactStatusAction {
	return &SetContactStatusAction{
		baseAction: newBaseAction(TypeSetContactStatus, uuid),
		Status:     status,
	}
}

// Execute runs this action
func (a *SetContactStatusAction) Execute(run flows.FlowRun, step flows.Step, logModifier flows.ModifierCallback, logEvent flows.EventCallback) error {
	if run.Contact() == nil {
		logEvent(events.NewErrorf("can't execute action in session without a contact"))
		return nil
	}

	a.applyModifier(run, modifiers.NewStatus(a.Status), logModifier, logEvent)
	return nil
}