Refactoring (#13)

Made Action trigger type type safer by introducing ActionTrigger
interface. Renamed some enums and their values. Removed some comments.

Signed-off-by: Milos Gajdos <milosthegajdos@gmail.com>

account_connections.go

@@ -14,8 +14,8 @@ import (
 type AccountConnType string
 
 const (
-	OpenAIConnType AccountConnType = "account_connection_openai"
-	TwilioConnType AccountConnType = "account_connection_twilio"
+	AccountConnOpenAI AccountConnType = "account_connection_openai"
+	AccountConnTwilio AccountConnType = "account_connection_twilio"
 )
 
 type OpenAICreds struct {
@@ -47,14 +47,12 @@ type TelAccountConn struct {
 }
 
 func (ta *TelAccountConn) UnmarshalJSON(data []byte) error {
-	// Check if the data is a plain string ID
 	var id string
 	if err := json.Unmarshal(data, &id); err == nil {
 		ta.ID = id
 		return nil
 	}
 
-	// Otherwise, unmarshal as a full TelAccountConn object
 	type Alias TelAccountConn
 	aux := &struct {
 		*Alias
@@ -144,13 +142,13 @@ func (a *AccountConn) UnmarshalJSON(data []byte) error {
 	a.AccountConnsBase = base
 
 	switch a.Type {
-	case OpenAIConnType:
+	case AccountConnOpenAI:
 		var openaiAccount OpenAIAccount
 		if err := json.Unmarshal(data, &openaiAccount); err != nil {
 			return err
 		}
 		a.OpenAIAccount = &openaiAccount
-	case TwilioConnType:
+	case AccountConnTwilio:
 		var twillioAccount TwilioAccount
 		if err := json.Unmarshal(data, &twillioAccount); err != nil {
 			return err
@@ -171,15 +169,15 @@ func (a AccountConnReqBase) MarshalJSON() ([]byte, error) {
 	type Alias AccountConnReqBase
 
 	switch a.Type {
-	case OpenAIConnType:
+	case AccountConnOpenAI:
 		return json.Marshal(&struct {
 			*Alias
 			*OpenAIAccount
 		}{
 			Alias:         (*Alias)(&a),
 			OpenAIAccount: a.OpenAIAccount,
 		})
-	case TwilioConnType:
+	case AccountConnTwilio:
 		return json.Marshal(&struct {
 			*Alias
 			*TwilioAccount

actions.go

@@ -11,6 +11,12 @@ import (
 	"github.com/milosgajdos/go-vocode/request"
 )
 
+// ActionTrigger must be implemented by
+// all action triggers.
+type ActionTrigger interface {
+	TriggerType() TriggerType
+}
+
 type TriggerType string
 
 const (
@@ -21,7 +27,7 @@ const (
 type PhraseCondition string
 
 const (
-	PhraseTypeContains PhraseCondition = "phrase_condition_type_contains"
+	PhraseCondTypeContains PhraseCondition = "phrase_condition_type_contains"
 )
 
 type Phrase struct {
@@ -38,20 +44,28 @@ type PhraseTrigger struct {
 	Config *PhraseTriggerConfig `json:"config"`
 }
 
+func (p *PhraseTrigger) TriggerType() TriggerType {
+	return PhraseTriggerType
+}
+
 type FnCallTrigger struct {
 	Type   TriggerType    `json:"type"`
 	Config map[string]any `json:"config"`
 }
 
+func (f *FnCallTrigger) TriggerType() TriggerType {
+	return FnCallTriggerType
+}
+
 type ActionType string
 
 const (
-	TransferCallActionType    ActionType = "action_transfer_call"
-	EndConversationActionType ActionType = "action_end_conversation"
-	DtmfActionType            ActionType = "action_dtmf"
-	AddToConferenceActionType ActionType = "action_add_to_conference"
-	SetHoldActionType         ActionType = "action_set_hold"
-	ExternalActionType        ActionType = "action_external"
+	ActionDTMF            ActionType = "action_dtmf"
+	ActionSetHold         ActionType = "action_set_hold"
+	ActionExternal        ActionType = "action_external"
+	ActionTransferCall    ActionType = "action_transfer_call"
+	ActionEndConversation ActionType = "action_end_conversation"
+	ActionAddToConference ActionType = "action_add_to_conference"
 )
 
 type TransferCallActionConfig struct {
@@ -110,10 +124,10 @@ type ExternalAction struct {
 }
 
 type ActionBase struct {
-	ID      string      `json:"id"`
-	UserID  string      `json:"user_id"`
-	Type    ActionType  `json:"type"`
-	Trigger interface{} `json:"action_trigger"`
+	ID      string        `json:"id"`
+	UserID  string        `json:"user_id"`
+	Type    ActionType    `json:"type"`
+	Trigger ActionTrigger `json:"action_trigger"`
 }
 
 type Action struct {
@@ -127,9 +141,9 @@ type Actions struct {
 }
 
 type ActionReqBase struct {
-	Type    ActionType  `json:"type"`
-	Config  interface{} `json:"config"`
-	Trigger interface{} `json:"action_trigger"`
+	Type    ActionType    `json:"type"`
+	Trigger ActionTrigger `json:"action_trigger"`
+	Config  interface{}   `json:"config"`
 }
 
 type CreateActionReq struct {
@@ -181,37 +195,37 @@ func (a *Action) UnmarshalJSON(data []byte) error {
 	}
 
 	switch a.Type {
-	case TransferCallActionType:
+	case ActionTransferCall:
 		var config TransferCallActionConfig
 		if err := json.Unmarshal(aux.RawConfig, &config); err != nil {
 			return err
 		}
 		a.Config = &config
-	case EndConversationActionType:
+	case ActionEndConversation:
 		var config map[string]interface{}
 		if err := json.Unmarshal(aux.RawConfig, &config); err != nil {
 			return err
 		}
 		a.Config = config
-	case DtmfActionType:
+	case ActionDTMF:
 		var config map[string]interface{}
 		if err := json.Unmarshal(aux.RawConfig, &config); err != nil {
 			return err
 		}
 		a.Config = config
-	case AddToConferenceActionType:
+	case ActionAddToConference:
 		var config AddToConfConfig
 		if err := json.Unmarshal(aux.RawConfig, &config); err != nil {
 			return err
 		}
 		a.Config = &config
-	case SetHoldActionType:
+	case ActionSetHold:
 		var config map[string]interface{}
 		if err := json.Unmarshal(aux.RawConfig, &config); err != nil {
 			return err
 		}
 		a.Config = config
-	case ExternalActionType:
+	case ActionExternal:
 		var config ExternalActionConfig
 		if err := json.Unmarshal(aux.RawConfig, &config); err != nil {
 			return err

examples/account_connections/main.go

@@ -33,7 +33,7 @@ func main() {
 
 	oaiConnReq := &vocode.CreateAccountConnReq{
 		AccountConnReqBase: vocode.AccountConnReqBase{
-			Type: vocode.OpenAIConnType,
+			Type: vocode.AccountConnOpenAI,
 			OpenAIAccount: &vocode.OpenAIAccount{
 				Creds: &vocode.OpenAICreds{
 					APIKey: oaiAPIKey,
@@ -50,7 +50,7 @@ func main() {
 
 	twillioConnReq := &vocode.CreateAccountConnReq{
 		AccountConnReqBase: vocode.AccountConnReqBase{
-			Type: vocode.TwilioConnType,
+			Type: vocode.AccountConnTwilio,
 			TwilioAccount: &vocode.TwilioAccount{
 				Creds: &vocode.TwilioCreds{
 					AccountID: twillioAccountID,

examples/actions/main.go

@@ -2,26 +2,41 @@ package main
 
 import (
 	"context"
+	"flag"
 	"log"
 
 	"github.com/milosgajdos/go-vocode"
 )
 
+var (
+	phoneNr string
+)
+
+func init() {
+	flag.StringVar(&phoneNr, "phone-nr", "", "phone number")
+}
+
 func main() {
+	flag.Parse()
+
+	if phoneNr == "" {
+		log.Fatal("must specify phone number")
+	}
+
 	client := vocode.NewClient()
 	ctx := context.Background()
 
 	extActionReq := &vocode.CreateActionReq{
 		ActionReqBase: vocode.ActionReqBase{
-			Type: vocode.ExternalActionType,
+			Type: vocode.ActionExternal,
 			Config: vocode.ExternalActionConfig{
 				ProcessingMode: vocode.MutedProcessing,
 				Name:           "Baseconfig",
 				Description:    "Some description",
 				URL:            "https://foobar.com",
 				InputSchema:    map[string]any{},
 			},
-			Trigger: vocode.FnCallTrigger{
+			Trigger: &vocode.FnCallTrigger{
 				Type:   vocode.FnCallTriggerType,
 				Config: map[string]any{},
 			},
@@ -36,11 +51,11 @@ func main() {
 
 	trCallActionReq := &vocode.CreateActionReq{
 		ActionReqBase: vocode.ActionReqBase{
-			Type: vocode.TransferCallActionType,
+			Type: vocode.ActionTransferCall,
 			Config: vocode.TransferCallActionConfig{
-				PhoneNr: "+19517449404",
+				PhoneNr: phoneNr,
 			},
-			Trigger: vocode.FnCallTrigger{
+			Trigger: &vocode.FnCallTrigger{
 				Type:   vocode.FnCallTriggerType,
 				Config: map[string]any{},
 			},

examples/prompts/main.go

@@ -16,7 +16,7 @@ func main() {
 			Content: "You are a voice assistant that answers questions about coding",
 			Fields: []vocode.Field{
 				{
-					Type:  vocode.FieldTypeEmail,
+					Type:  vocode.EmailFieldType,
 					Label: "Foo",
 					Name:  "FooPrompt",
 					Desc:  "Example prompt",

examples/webhooks/main.go

@@ -14,11 +14,11 @@ func main() {
 	whCreateReq := &vocode.CreateWebhookReq{
 		WebhookReqBase: vocode.WebhookReqBase{
 			Subs: []vocode.Event{
-				vocode.EventMessage,
-				vocode.EventAction,
+				vocode.MessageEvent,
+				vocode.ActionEvent,
 			},
 			URL:    "https://foobar.com",
-			Method: vocode.Post,
+			Method: vocode.PostWebhook,
 		},
 	}
 

prompts.go

@@ -13,7 +13,7 @@ import (
 type FieldType string
 
 const (
-	FieldTypeEmail FieldType = "field_type_email"
+	EmailFieldType FieldType = "field_type_email"
 )
 
 type Field struct {
@@ -45,14 +45,12 @@ type Prompt struct {
 }
 
 func (p *Prompt) UnmarshalJSON(data []byte) error {
-	// Check if the data is a plain string ID
 	var id string
 	if err := json.Unmarshal(data, &id); err == nil {
 		p.ID = id
 		return nil
 	}
 
-	// Otherwise, unmarshal as a full TelAccountConn object
 	type Alias Prompt
 	aux := &struct {
 		*Alias

webhooks.go

@@ -13,21 +13,21 @@ import (
 type Event string
 
 const (
-	EventMessage          Event = "event_message"
-	EventAction           Event = "event_action"
-	EventCallConnected    Event = "event_phone_call_connected"
-	EventCallEnded        Event = "event_phone_call_ended"
-	EventCallDidntConnect Event = "event_phone_call_did_not_connect"
-	EventTranscript       Event = "event_transcript"
-	EventRecording        Event = "event_recording"
-	EventHumanDetection   Event = "event_human_detection"
+	MessageEvent          Event = "event_message"
+	ActionEvent           Event = "event_action"
+	CallConnectedEvent    Event = "event_phone_call_connected"
+	CallEndedEvent        Event = "event_phone_call_ended"
+	CallDidntConnectEvent Event = "event_phone_call_did_not_connect"
+	TranscriptEvent       Event = "event_transcript"
+	RecordingEvent        Event = "event_recording"
+	HumanDetectionEvent   Event = "event_human_detection"
 )
 
 type WebhookMethod string
 
 const (
-	Get  WebhookMethod = "GET"
-	Post WebhookMethod = "POST"
+	GetWebhook  WebhookMethod = "GET"
+	PostWebhook WebhookMethod = "POST"
 )
 
 type Webhooks struct {