widgets

Documentation

Overview

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Package widgets contains auto-generated files. DO NOT MODIFY

Index

• type AddTwimlRedirect
  • func (widget AddTwimlRedirect) ToState() (*flow.State, error)
  • func (widget AddTwimlRedirect) Validate() error
• type AddTwimlRedirectNextTransitions
• type AddTwimlRedirectProperties
• type CapturePayments
  • func (widget CapturePayments) ToState() (*flow.State, error)
  • func (widget CapturePayments) Validate() error
• type CapturePaymentsNextTransitions
• type CapturePaymentsParameter
• type CapturePaymentsProperties
• type ConnectCallTo
  • func (widget ConnectCallTo) ToState() (*flow.State, error)
  • func (widget ConnectCallTo) Validate() error
• type ConnectCallToNextTransitions
• type ConnectCallToProperties
• type ConnectVirtualAgent
  • func (widget ConnectVirtualAgent) ToState() (*flow.State, error)
  • func (widget ConnectVirtualAgent) Validate() error
• type ConnectVirtualAgentNextTransitions
• type ConnectVirtualAgentProperties
• type EnqueueCall
  • func (widget EnqueueCall) ToState() (*flow.State, error)
  • func (widget EnqueueCall) Validate() error
• type EnqueueCallNextTransitions
• type EnqueueCallProperties
• type ForkStream
  • func (widget ForkStream) ToState() (*flow.State, error)
  • func (widget ForkStream) Validate() error
• type ForkStreamNextTransitions
• type ForkStreamProperties
• type ForkStreamStreamParameter
• type GatherInputOnCall
  • func (widget GatherInputOnCall) ToState() (*flow.State, error)
  • func (widget GatherInputOnCall) Validate() error
• type GatherInputOnCallNextTransitions
• type GatherInputOnCallProperties
• type MakeHTTPRequest
  • func (widget MakeHTTPRequest) ToState() (*flow.State, error)
  • func (widget MakeHTTPRequest) Validate() error
• type MakeHTTPRequestNextTransitions
• type MakeHTTPRequestParameter
• type MakeHTTPRequestProperties
• type MakeOutgoingCall
  • func (widget MakeOutgoingCall) ToState() (*flow.State, error)
  • func (widget MakeOutgoingCall) Validate() error
• type MakeOutgoingCallNextTransitions
• type MakeOutgoingCallProperties
• type RecordCall
  • func (widget RecordCall) ToState() (*flow.State, error)
  • func (widget RecordCall) Validate() error
• type RecordCallNextTransitions
• type RecordCallProperties
• type RecordVoicemail
  • func (widget RecordVoicemail) ToState() (*flow.State, error)
  • func (widget RecordVoicemail) Validate() error
• type RecordVoicemailNextTransitions
• type RecordVoicemailProperties
• type RunFunction
  • func (widget RunFunction) ToState() (*flow.State, error)
  • func (widget RunFunction) Validate() error
• type RunFunctionNextTransitions
• type RunFunctionParameter
• type RunFunctionProperties
• type RunSubflow
  • func (widget RunSubflow) ToState() (*flow.State, error)
  • func (widget RunSubflow) Validate() error
• type RunSubflowNextTransitions
• type RunSubflowParameter
• type RunSubflowProperties
• type SayPlay
  • func (widget SayPlay) ToState() (*flow.State, error)
  • func (widget SayPlay) Validate() error
• type SayPlayNextTransitions
• type SayPlayProperties
• type SendAndWaitForReply
  • func (widget SendAndWaitForReply) ToState() (*flow.State, error)
  • func (widget SendAndWaitForReply) Validate() error
• type SendAndWaitForReplyNextTransitions
• type SendAndWaitForReplyProperties
• type SendMessage
  • func (widget SendMessage) ToState() (*flow.State, error)
  • func (widget SendMessage) Validate() error
• type SendMessageNextTransitions
• type SendMessageProperties
• type SendToAutopilot
  • func (widget SendToAutopilot) ToState() (*flow.State, error)
  • func (widget SendToAutopilot) Validate() error
• type SendToAutopilotMemoryParameter
• type SendToAutopilotNextTransitions
• type SendToAutopilotProperties
• type SendToFlex
  • func (widget SendToFlex) ToState() (*flow.State, error)
  • func (widget SendToFlex) Validate() error
• type SendToFlexNextTransitions
• type SendToFlexProperties
• type SetVariables
  • func (widget SetVariables) ToState() (*flow.State, error)
  • func (widget SetVariables) Validate() error
• type SetVariablesNextTransitions
• type SetVariablesProperties
• type SetVariablesVariable
• type SplitBasedOn
  • func (widget SplitBasedOn) ToState() (*flow.State, error)
  • func (widget SplitBasedOn) Validate() error
• type SplitBasedOnNextTransitions
• type SplitBasedOnProperties
• type Trigger
  • func (widget Trigger) ToState() (*flow.State, error)
  • func (widget Trigger) Validate() error
• type TriggerNextTransitions
• type TriggerProperties

Types

type AddTwimlRedirect

type AddTwimlRedirect struct {
	NextTransitions AddTwimlRedirectNextTransitions
	Properties      AddTwimlRedirectProperties `validate:"required"`
	Name            string                     `validate:"required"`
}

func (AddTwimlRedirect) ToState

func (widget AddTwimlRedirect) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (AddTwimlRedirect) Validate

func (widget AddTwimlRedirect) Validate() error

Validate checks the widget is correctly configured

type AddTwimlRedirectNextTransitions

type AddTwimlRedirectNextTransitions struct {
	Fail    *string
	Return  *string
	Timeout *string
}

type AddTwimlRedirectProperties

type AddTwimlRedirectProperties struct {
	Method  *string            `json:"method,omitempty"`
	Offset  *properties.Offset `json:"offset,omitempty"`
	Timeout *string            `json:"timeout,omitempty"`
	URL     string             `validate:"required" json:"url"`
}

type CapturePayments

type CapturePayments struct {
	NextTransitions CapturePaymentsNextTransitions
	Properties      CapturePaymentsProperties `validate:"required"`
	Name            string                    `validate:"required"`
}

func (CapturePayments) ToState

func (widget CapturePayments) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (CapturePayments) Validate

func (widget CapturePayments) Validate() error

Validate checks the widget is correctly configured

type CapturePaymentsNextTransitions

type CapturePaymentsNextTransitions struct {
	Hangup            *string
	MaxFailedAttempts *string
	PayInterrupted    *string
	ProviderError     *string
	Success           *string
	ValidationError   *string
}

type CapturePaymentsParameter

type CapturePaymentsParameter struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type CapturePaymentsProperties

type CapturePaymentsProperties struct {
	Currency            *string                     `json:"currency,omitempty"`
	Description         *string                     `json:"description,omitempty"`
	Language            *string                     `json:"language,omitempty"`
	MaxAttempts         *int                        `json:"max_attempts,omitempty"`
	MinPostalCodeLength *int                        `json:"min_postal_code_length,omitempty"`
	Offset              *properties.Offset          `json:"offset,omitempty"`
	Parameters          *[]CapturePaymentsParameter `json:"parameters,omitempty"`
	PaymentAmount       *string                     `json:"payment_amount,omitempty"`
	PaymentConnector    *string                     `json:"payment_connector,omitempty"`
	PaymentMethod       *string                     `json:"payment_method,omitempty"`
	PaymentTokenType    *string                     `json:"payment_token_type,omitempty"`
	PostalCode          *string                     `json:"postal_code,omitempty"`
	SecurityCode        *bool                       `json:"security_code,omitempty"`
	Timeout             *int                        `json:"timeout,omitempty"`
	ValidCardTypes      *[]string                   `json:"valid_card_types,omitempty"`
}

type ConnectCallTo

type ConnectCallTo struct {
	NextTransitions ConnectCallToNextTransitions
	Properties      ConnectCallToProperties `validate:"required"`
	Name            string                  `validate:"required"`
}

func (ConnectCallTo) ToState

func (widget ConnectCallTo) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (ConnectCallTo) Validate

func (widget ConnectCallTo) Validate() error

Validate checks the widget is correctly configured

type ConnectCallToNextTransitions

type ConnectCallToNextTransitions struct {
	CallCompleted *string
	Hangup        *string
}

type ConnectCallToProperties

type ConnectCallToProperties struct {
	CallerID    string             `validate:"required" json:"caller_id"`
	Noun        string             `validate:"required" json:"noun"`
	Offset      *properties.Offset `json:"offset,omitempty"`
	Record      *bool              `json:"record,omitempty"`
	SipEndpoint *string            `json:"sip_endpoint,omitempty"`
	SipPassword *string            `json:"sip_password,omitempty"`
	SipUsername *string            `json:"sip_username,omitempty"`
	Timeout     *int               `json:"timeout,omitempty"`
	To          *string            `json:"to,omitempty"`
}

type ConnectVirtualAgent

type ConnectVirtualAgent struct {
	NextTransitions ConnectVirtualAgentNextTransitions
	Properties      ConnectVirtualAgentProperties `validate:"required"`
	Name            string                        `validate:"required"`
}

func (ConnectVirtualAgent) ToState

func (widget ConnectVirtualAgent) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (ConnectVirtualAgent) Validate

func (widget ConnectVirtualAgent) Validate() error

Validate checks the widget is correctly configured

type ConnectVirtualAgentNextTransitions

type ConnectVirtualAgentNextTransitions struct {
	Hangup *string
	Return *string
}

type ConnectVirtualAgentProperties

type ConnectVirtualAgentProperties struct {
	Connector         string             `validate:"required" json:"connector"`
	Language          *string            `json:"language,omitempty"`
	Offset            *properties.Offset `json:"offset,omitempty"`
	SentimentAnalysis *string            `json:"sentiment_analysis,omitempty"`
	StatusCallbackURL *string            `json:"status_callback,omitempty"`
}

type EnqueueCall

type EnqueueCall struct {
	NextTransitions EnqueueCallNextTransitions
	Properties      EnqueueCallProperties `validate:"required"`
	Name            string                `validate:"required"`
}

func (EnqueueCall) ToState

func (widget EnqueueCall) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (EnqueueCall) Validate

func (widget EnqueueCall) Validate() error

Validate checks the widget is correctly configured

type EnqueueCallNextTransitions

type EnqueueCallNextTransitions struct {
	CallComplete    *string
	CallFailure     *string
	FailedToEnqueue *string
}

type EnqueueCallProperties

type EnqueueCallProperties struct {
	Offset         *properties.Offset `json:"offset,omitempty"`
	Priority       *int               `json:"priority,omitempty"`
	QueueName      *string            `json:"queue_name,omitempty"`
	TaskAttributes *string            `json:"task_attributes,omitempty"`
	Timeout        *int               `json:"timeout,omitempty"`
	WaitURL        *string            `json:"wait_url,omitempty"`
	WaitURLMethod  *string            `json:"wait_url_method,omitempty"`
	WorkflowSid    *string            `json:"workflow_sid,omitempty"`
}

type ForkStream

type ForkStream struct {
	NextTransitions ForkStreamNextTransitions
	Properties      ForkStreamProperties `validate:"required"`
	Name            string               `validate:"required"`
}

func (ForkStream) ToState

func (widget ForkStream) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (ForkStream) Validate

func (widget ForkStream) Validate() error

Validate checks the widget is correctly configured

type ForkStreamNextTransitions

type ForkStreamNextTransitions struct {
	Next *string
}

type ForkStreamProperties

type ForkStreamProperties struct {
	Offset              *properties.Offset           `json:"offset,omitempty"`
	StreamAction        string                       `validate:"required" json:"stream_action"`
	StreamConnector     *string                      `json:"stream_connector,omitempty"`
	StreamName          *string                      `json:"stream_name,omitempty"`
	StreamParameters    *[]ForkStreamStreamParameter `json:"stream_parameters,omitempty"`
	StreamTrack         *string                      `json:"stream_track,omitempty"`
	StreamTransportType *string                      `json:"stream_transport_type,omitempty"`
	StreamURL           *string                      `json:"stream_url,omitempty"`
}

type ForkStreamStreamParameter

type ForkStreamStreamParameter struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type GatherInputOnCall

type GatherInputOnCall struct {
	NextTransitions GatherInputOnCallNextTransitions
	Properties      GatherInputOnCallProperties `validate:"required"`
	Name            string                      `validate:"required"`
}

func (GatherInputOnCall) ToState

func (widget GatherInputOnCall) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (GatherInputOnCall) Validate

func (widget GatherInputOnCall) Validate() error

Validate checks the widget is correctly configured

type GatherInputOnCallNextTransitions

type GatherInputOnCallNextTransitions struct {
	Keypress *string
	Speech   *string
	Timeout  *string
}

type GatherInputOnCallProperties

type GatherInputOnCallProperties struct {
	FinishOnKey     *string            `json:"finish_on_key,omitempty"`
	GatherLanguage  *string            `json:"gather_language,omitempty"`
	Hints           *string            `json:"hints,omitempty"`
	Language        *string            `json:"language,omitempty"`
	Loop            *int               `json:"loop,omitempty"`
	NumberOfDigits  *int               `json:"number_of_digits,omitempty"`
	Offset          *properties.Offset `json:"offset,omitempty"`
	Play            *string            `json:"play,omitempty"`
	ProfanityFilter *string            `json:"profanity_filter,omitempty"`
	Say             *string            `json:"say,omitempty"`
	SpeechModel     *string            `json:"speech_model,omitempty"`
	SpeechTimeout   *string            `json:"speech_timeout,omitempty"`
	StopGather      *bool              `json:"stop_gather,omitempty"`
	Timeout         *int               `json:"timeout,omitempty"`
	Voice           *string            `json:"voice,omitempty"`
}

type MakeHTTPRequest

type MakeHTTPRequest struct {
	NextTransitions MakeHTTPRequestNextTransitions
	Properties      MakeHTTPRequestProperties `validate:"required"`
	Name            string                    `validate:"required"`
}

func (MakeHTTPRequest) ToState

func (widget MakeHTTPRequest) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (MakeHTTPRequest) Validate

func (widget MakeHTTPRequest) Validate() error

Validate checks the widget is correctly configured

type MakeHTTPRequestNextTransitions

type MakeHTTPRequestNextTransitions struct {
	Failed  *string
	Success *string
}

type MakeHTTPRequestParameter

type MakeHTTPRequestParameter struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type MakeHTTPRequestProperties

type MakeHTTPRequestProperties struct {
	Body        *string                     `json:"body,omitempty"`
	ContentType string                      `validate:"required" json:"content_type"`
	Method      string                      `validate:"required" json:"method"`
	Offset      *properties.Offset          `json:"offset,omitempty"`
	Parameters  *[]MakeHTTPRequestParameter `json:"parameters,omitempty"`
	URL         string                      `validate:"required" json:"url"`
}

type MakeOutgoingCall

type MakeOutgoingCall struct {
	NextTransitions MakeOutgoingCallNextTransitions
	Properties      MakeOutgoingCallProperties `validate:"required"`
	Name            string                     `validate:"required"`
}

func (MakeOutgoingCall) ToState

func (widget MakeOutgoingCall) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (MakeOutgoingCall) Validate

func (widget MakeOutgoingCall) Validate() error

Validate checks the widget is correctly configured

type MakeOutgoingCallNextTransitions

type MakeOutgoingCallNextTransitions struct {
	Answered *string
	Busy     *string
	Failed   *string
	NoAnswer *string
}

type MakeOutgoingCallProperties

type MakeOutgoingCallProperties struct {
	DetectAnsweringMachine             *bool              `json:"detect_answering_machine,omitempty"`
	From                               string             `validate:"required" json:"from"`
	MachineDetection                   *string            `json:"machine_detection,omitempty"`
	MachineDetectionSilenceTimeout     *string            `json:"machine_detection_silence_timeout,omitempty"`
	MachineDetectionSpeechEndThreshold *string            `json:"machine_detection_speech_end_threshold,omitempty"`
	MachineDetectionSpeechThreshold    *string            `json:"machine_detection_speech_threshold,omitempty"`
	MachineDetectionTimeout            *string            `json:"machine_detection_timeout,omitempty"`
	Offset                             *properties.Offset `json:"offset,omitempty"`
	Record                             *bool              `json:"record,omitempty"`
	RecordingChannels                  *string            `json:"recording_channels,omitempty"`
	RecordingStatusCallbackURL         *string            `json:"recording_status_callback,omitempty"`
	SendDigits                         *string            `json:"send_digits,omitempty"`
	SipAuthPassword                    *string            `json:"sip_auth_password,omitempty"`
	SipAuthUsername                    *string            `json:"sip_auth_username,omitempty"`
	Timeout                            *int               `json:"timeout,omitempty"`
	To                                 string             `validate:"required" json:"to"`
	Trim                               *string            `json:"trim,omitempty"`
}

type RecordCall

type RecordCall struct {
	NextTransitions RecordCallNextTransitions
	Properties      RecordCallProperties `validate:"required"`
	Name            string               `validate:"required"`
}

func (RecordCall) ToState

func (widget RecordCall) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (RecordCall) Validate

func (widget RecordCall) Validate() error

Validate checks the widget is correctly configured

type RecordCallNextTransitions

type RecordCallNextTransitions struct {
	Failed  *string
	Success *string
}

type RecordCallProperties

type RecordCallProperties struct {
	Offset                        *properties.Offset `json:"offset,omitempty"`
	RecordCall                    bool               `json:"record_call"`
	RecordingChannels             *string            `json:"recording_channels,omitempty"`
	RecordingStatusCallbackEvents *string            `json:"recording_status_callback_events,omitempty"`
	RecordingStatusCallbackMethod *string            `json:"recording_status_callback_method,omitempty"`
	RecordingStatusCallbackURL    *string            `json:"recording_status_callback,omitempty"`
	Trim                          *string            `json:"trim,omitempty"`
}

type RecordVoicemail

type RecordVoicemail struct {
	NextTransitions RecordVoicemailNextTransitions
	Properties      RecordVoicemailProperties `validate:"required"`
	Name            string                    `validate:"required"`
}

func (RecordVoicemail) ToState

func (widget RecordVoicemail) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (RecordVoicemail) Validate

func (widget RecordVoicemail) Validate() error

Validate checks the widget is correctly configured

type RecordVoicemailNextTransitions

type RecordVoicemailNextTransitions struct {
	Hangup            *string
	NoAudio           *string
	RecordingComplete *string
}

type RecordVoicemailProperties

type RecordVoicemailProperties struct {
	FinishOnKey                *string            `json:"finish_on_key,omitempty"`
	MaxLength                  *int               `json:"max_length,omitempty"`
	Offset                     *properties.Offset `json:"offset,omitempty"`
	PlayBeep                   *string            `json:"play_beep,omitempty"`
	RecordingStatusCallbackURL *string            `json:"recording_status_callback_url,omitempty"`
	Timeout                    *int               `json:"timeout,omitempty"`
	Transcribe                 *bool              `json:"transcribe,omitempty"`
	TranscriptionCallbackURL   *string            `json:"transcription_callback_url,omitempty"`
	Trim                       *string            `json:"trim,omitempty"`
}

type RunFunction

type RunFunction struct {
	NextTransitions RunFunctionNextTransitions
	Properties      RunFunctionProperties `validate:"required"`
	Name            string                `validate:"required"`
}

func (RunFunction) ToState

func (widget RunFunction) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (RunFunction) Validate

func (widget RunFunction) Validate() error

Validate checks the widget is correctly configured

type RunFunctionNextTransitions

type RunFunctionNextTransitions struct {
	Fail    *string
	Success *string
}

type RunFunctionParameter

type RunFunctionParameter struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type RunFunctionProperties

type RunFunctionProperties struct {
	EnvironmentSid *string                 `json:"environment_sid,omitempty"`
	FunctionSid    *string                 `json:"function_sid,omitempty"`
	Offset         *properties.Offset      `json:"offset,omitempty"`
	Parameters     *[]RunFunctionParameter `json:"parameters,omitempty"`
	ServiceSid     *string                 `json:"service_sid,omitempty"`
	URL            string                  `validate:"required" json:"url"`
}

type RunSubflow

type RunSubflow struct {
	NextTransitions RunSubflowNextTransitions
	Properties      RunSubflowProperties `validate:"required"`
	Name            string               `validate:"required"`
}

func (RunSubflow) ToState

func (widget RunSubflow) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (RunSubflow) Validate

func (widget RunSubflow) Validate() error

Validate checks the widget is correctly configured

type RunSubflowNextTransitions

type RunSubflowNextTransitions struct {
	Completed *string
	Failed    *string
}

type RunSubflowParameter

type RunSubflowParameter struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type RunSubflowProperties

type RunSubflowProperties struct {
	FlowRevision string                 `validate:"required" json:"flow_revision"`
	FlowSid      string                 `validate:"required" json:"flow_sid"`
	Offset       *properties.Offset     `json:"offset,omitempty"`
	Parameters   *[]RunSubflowParameter `json:"parameters,omitempty"`
}

type SayPlay

type SayPlay struct {
	NextTransitions SayPlayNextTransitions
	Properties      SayPlayProperties `validate:"required"`
	Name            string            `validate:"required"`
}

func (SayPlay) ToState

func (widget SayPlay) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SayPlay) Validate

func (widget SayPlay) Validate() error

Validate checks the widget is correctly configured

type SayPlayNextTransitions

type SayPlayNextTransitions struct {
	AudioComplete *string
}

type SayPlayProperties

type SayPlayProperties struct {
	Digits   *string            `json:"digits,omitempty"`
	Language *string            `json:"language,omitempty"`
	Loop     *int               `json:"loop,omitempty"`
	Offset   *properties.Offset `json:"offset,omitempty"`
	Play     *string            `json:"play,omitempty"`
	Say      *string            `json:"say,omitempty"`
	Voice    *string            `json:"voice,omitempty"`
}

type SendAndWaitForReply

type SendAndWaitForReply struct {
	NextTransitions SendAndWaitForReplyNextTransitions
	Properties      SendAndWaitForReplyProperties `validate:"required"`
	Name            string                        `validate:"required"`
}

SendAndWaitForReply widget allows you to send a SMS and wait for a reply

func (SendAndWaitForReply) ToState

func (widget SendAndWaitForReply) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SendAndWaitForReply) Validate

func (widget SendAndWaitForReply) Validate() error

Validate checks the widget is correctly configured

type SendAndWaitForReplyNextTransitions

type SendAndWaitForReplyNextTransitions struct {
	DeliveryFailure *string
	IncomingMessage string `validate:"required"`
	Timeout         *string
}

type SendAndWaitForReplyProperties

type SendAndWaitForReplyProperties struct {
	Attributes *string            `json:"attributes,omitempty"`
	Body       string             `validate:"required" json:"body"`
	Channel    *string            `json:"channel,omitempty"`
	From       string             `validate:"required" json:"from"`
	MediaURL   *string            `json:"media_url,omitempty"`
	Offset     *properties.Offset `json:"offset,omitempty"`
	Service    *string            `json:"service,omitempty"`
	Timeout    string             `validate:"required" json:"timeout"`
}

type SendMessage

type SendMessage struct {
	NextTransitions SendMessageNextTransitions
	Properties      SendMessageProperties `validate:"required"`
	Name            string                `validate:"required"`
}

func (SendMessage) ToState

func (widget SendMessage) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SendMessage) Validate

func (widget SendMessage) Validate() error

Validate checks the widget is correctly configured

type SendMessageNextTransitions

type SendMessageNextTransitions struct {
	Failed *string
	Sent   *string
}

type SendMessageProperties

type SendMessageProperties struct {
	Attributes *string            `json:"attributes,omitempty"`
	Body       string             `validate:"required" json:"body"`
	Channel    *string            `json:"channel,omitempty"`
	From       string             `validate:"required" json:"from"`
	MediaURL   *string            `json:"media_url,omitempty"`
	Offset     *properties.Offset `json:"offset,omitempty"`
	Service    *string            `json:"service,omitempty"`
	To         string             `validate:"required" json:"to"`
}

type SendToAutopilot

type SendToAutopilot struct {
	NextTransitions SendToAutopilotNextTransitions
	Properties      SendToAutopilotProperties `validate:"required"`
	Name            string                    `validate:"required"`
}

func (SendToAutopilot) ToState

func (widget SendToAutopilot) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SendToAutopilot) Validate

func (widget SendToAutopilot) Validate() error

Validate checks the widget is correctly configured

type SendToAutopilotMemoryParameter

type SendToAutopilotMemoryParameter struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type SendToAutopilotNextTransitions

type SendToAutopilotNextTransitions struct {
	Failure      *string
	SessionEnded *string
	Timeout      *string
}

type SendToAutopilotProperties

type SendToAutopilotProperties struct {
	AutopilotAssistantSid string                            `validate:"required" json:"autopilot_assistant_sid"`
	Body                  string                            `validate:"required" json:"body"`
	ChatAttributes        *string                           `json:"chat_attributes,omitempty"`
	ChatChannel           *string                           `json:"chat_channel,omitempty"`
	ChatService           *string                           `json:"chat_service,omitempty"`
	From                  string                            `validate:"required" json:"from"`
	MemoryParameters      *[]SendToAutopilotMemoryParameter `json:"memory_parameters,omitempty"`
	Offset                *properties.Offset                `json:"offset,omitempty"`
	TargetTask            *string                           `json:"target_task,omitempty"`
	Timeout               int                               `validate:"required" json:"timeout"`
}

type SendToFlex

type SendToFlex struct {
	NextTransitions SendToFlexNextTransitions
	Properties      SendToFlexProperties `validate:"required"`
	Name            string               `validate:"required"`
}

func (SendToFlex) ToState

func (widget SendToFlex) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SendToFlex) Validate

func (widget SendToFlex) Validate() error

Validate checks the widget is correctly configured

type SendToFlexNextTransitions

type SendToFlexNextTransitions struct {
	CallComplete    *string
	CallFailure     *string
	FailedToEnqueue *string
}

type SendToFlexProperties

type SendToFlexProperties struct {
	Attributes    *string            `json:"attributes,omitempty"`
	Channel       string             `validate:"required" json:"channel"`
	Offset        *properties.Offset `json:"offset,omitempty"`
	Priority      *string            `json:"priority,omitempty"`
	Timeout       *string            `json:"timeout,omitempty"`
	WaitURL       *string            `json:"waitUrl,omitempty"`
	WaitURLMethod *string            `json:"waitUrlMethod,omitempty"`
	Workflow      string             `validate:"required" json:"workflow"`
}

type SetVariables

type SetVariables struct {
	NextTransitions SetVariablesNextTransitions
	Properties      SetVariablesProperties `validate:"required"`
	Name            string                 `validate:"required"`
}

func (SetVariables) ToState

func (widget SetVariables) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SetVariables) Validate

func (widget SetVariables) Validate() error

Validate checks the widget is correctly configured

type SetVariablesNextTransitions

type SetVariablesNextTransitions struct {
	Next *string
}

type SetVariablesProperties

type SetVariablesProperties struct {
	Offset    *properties.Offset      `json:"offset,omitempty"`
	Variables *[]SetVariablesVariable `json:"variables,omitempty"`
}

type SetVariablesVariable

type SetVariablesVariable struct {
	Key   string `validate:"required" json:"key"`
	Value string `validate:"required" json:"value"`
}

type SplitBasedOn

type SplitBasedOn struct {
	NextTransitions SplitBasedOnNextTransitions
	Properties      SplitBasedOnProperties `validate:"required"`
	Name            string                 `validate:"required"`
}

func (SplitBasedOn) ToState

func (widget SplitBasedOn) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (SplitBasedOn) Validate

func (widget SplitBasedOn) Validate() error

Validate checks the widget is correctly configured

type SplitBasedOnNextTransitions

type SplitBasedOnNextTransitions struct {
	NoMatch *string

	Matches *[]transition.Conditional
}

type SplitBasedOnProperties

type SplitBasedOnProperties struct {
	Input  string             `validate:"required" json:"input"`
	Offset *properties.Offset `json:"offset,omitempty"`
}

type Trigger

type Trigger struct {
	NextTransitions TriggerNextTransitions
	Properties      TriggerProperties `validate:"required"`
	Name            string            `validate:"required"`
}

func (Trigger) ToState

func (widget Trigger) ToState() (*flow.State, error)

ToState returns a populated Studio Widget State struct

func (Trigger) Validate

func (widget Trigger) Validate() error

Validate checks the widget is correctly configured

type TriggerNextTransitions

type TriggerNextTransitions struct {
	IncomingCall    *string
	IncomingMessage *string
	IncomingParent  *string
	IncomingRequest *string
}

type TriggerProperties

type TriggerProperties struct {
	Offset *properties.Offset `json:"offset,omitempty"`
}