Class: Vapi::ClientMessageMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/client_message_message.rb

Overview

These are all the messages that can be sent to the client-side SDKs during the

call. Configure the messages you'd like to receive in
`assistant.clientMessages`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(member:, discriminant:) ⇒ Vapi::ClientMessageMessage 



34
35
36
37
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 34

def initialize(member:, discriminant:)
  @member = member
  @discriminant = discriminant
end

Instance Attribute Details

#discriminant ⇒ String (readonly) 



26
27
28
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 26

def discriminant
  @discriminant
end

#member ⇒ Object (readonly) 



24
25
26
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 24

def member
  @member
end

Class Method Details

.conversation_update(member:) ⇒ Vapi::ClientMessageMessage 



170
171
172
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 170

def self.conversation_update(member:)
  new(member: member, discriminant: "conversation-update")
end

.from_json(json_object:) ⇒ Vapi::ClientMessageMessage

Deserialize a JSON object to an instance of ClientMessageMessage



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 43

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           when "workflow.node.started"
             Vapi::ClientMessageWorkflowNodeStarted.from_json(json_object: json_object)
           when "conversation-update"
             Vapi::ClientMessageConversationUpdate.from_json(json_object: json_object)
           when "hang"
             Vapi::ClientMessageHang.from_json(json_object: json_object)
           when "metadata"
             Vapi::ClientMessageMetadata.from_json(json_object: json_object)
           when "model-output"
             Vapi::ClientMessageModelOutput.from_json(json_object: json_object)
           when "speech-update"
             Vapi::ClientMessageSpeechUpdate.from_json(json_object: json_object)
           when "transcript[transcriptType='final']"
             Vapi::ClientMessageTranscript.from_json(json_object: json_object)
           when "tool-calls"
             Vapi::ClientMessageToolCalls.from_json(json_object: json_object)
           when "tool-calls-result"
             Vapi::ClientMessageToolCallsResult.from_json(json_object: json_object)
           when "transfer-update"
             Vapi::ClientMessageTransferUpdate.from_json(json_object: json_object)
           when "user-interrupted"
             Vapi::ClientMessageUserInterrupted.from_json(json_object: json_object)
           when "language-change-detected"
             Vapi::ClientMessageLanguageChangeDetected.from_json(json_object: json_object)
           when "voice-input"
             Vapi::ClientMessageVoiceInput.from_json(json_object: json_object)
           else
             Vapi::ClientMessageWorkflowNodeStarted.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.hang(member:) ⇒ Vapi::ClientMessageMessage 



176
177
178
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 176

def self.hang(member:)
  new(member: member, discriminant: "hang")
end

.language_change_detected(member:) ⇒ Vapi::ClientMessageMessage 



230
231
232
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 230

def self.language_change_detected(member:)
  new(member: member, discriminant: "language-change-detected")
end

.metadata(member:) ⇒ Vapi::ClientMessageMessage 



182
183
184
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 182

def self.metadata(member:)
  new(member: member, discriminant: "metadata")
end

.model_output(member:) ⇒ Vapi::ClientMessageMessage 



188
189
190
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 188

def self.model_output(member:)
  new(member: member, discriminant: "model-output")
end

.speech_update(member:) ⇒ Vapi::ClientMessageMessage 



194
195
196
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 194

def self.speech_update(member:)
  new(member: member, discriminant: "speech-update")
end

.tool_calls(member:) ⇒ Vapi::ClientMessageMessage 



206
207
208
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 206

def self.tool_calls(member:)
  new(member: member, discriminant: "tool-calls")
end

.tool_calls_result(member:) ⇒ Vapi::ClientMessageMessage 



212
213
214
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 212

def self.tool_calls_result(member:)
  new(member: member, discriminant: "tool-calls-result")
end

.transcript_transcript_type_final(member:) ⇒ Vapi::ClientMessageMessage 



200
201
202
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 200

def self.transcript_transcript_type_final(member:)
  new(member: member, discriminant: "transcript[transcriptType='final']")
end

.transfer_update(member:) ⇒ Vapi::ClientMessageMessage 



218
219
220
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 218

def self.transfer_update(member:)
  new(member: member, discriminant: "transfer-update")
end

.user_interrupted(member:) ⇒ Vapi::ClientMessageMessage 



224
225
226
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 224

def self.user_interrupted(member:)
  new(member: member, discriminant: "user-interrupted")
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 121

def self.validate_raw(obj:)
  case obj.type
  when "workflow.node.started"
    Vapi::ClientMessageWorkflowNodeStarted.validate_raw(obj: obj)
  when "conversation-update"
    Vapi::ClientMessageConversationUpdate.validate_raw(obj: obj)
  when "hang"
    Vapi::ClientMessageHang.validate_raw(obj: obj)
  when "metadata"
    Vapi::ClientMessageMetadata.validate_raw(obj: obj)
  when "model-output"
    Vapi::ClientMessageModelOutput.validate_raw(obj: obj)
  when "speech-update"
    Vapi::ClientMessageSpeechUpdate.validate_raw(obj: obj)
  when "transcript[transcriptType='final']"
    Vapi::ClientMessageTranscript.validate_raw(obj: obj)
  when "tool-calls"
    Vapi::ClientMessageToolCalls.validate_raw(obj: obj)
  when "tool-calls-result"
    Vapi::ClientMessageToolCallsResult.validate_raw(obj: obj)
  when "transfer-update"
    Vapi::ClientMessageTransferUpdate.validate_raw(obj: obj)
  when "user-interrupted"
    Vapi::ClientMessageUserInterrupted.validate_raw(obj: obj)
  when "language-change-detected"
    Vapi::ClientMessageLanguageChangeDetected.validate_raw(obj: obj)
  when "voice-input"
    Vapi::ClientMessageVoiceInput.validate_raw(obj: obj)
  else
    raise("Passed value matched no type within the union, validation failed.")
  end
end

.voice_input(member:) ⇒ Vapi::ClientMessageMessage 



236
237
238
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 236

def self.voice_input(member:)
  new(member: member, discriminant: "voice-input")
end

.workflow_node_started(member:) ⇒ Vapi::ClientMessageMessage 



164
165
166
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 164

def self.workflow_node_started(member:)
  new(member: member, discriminant: "workflow.node.started")
end

Instance Method Details

#is_a?(obj) ⇒ Boolean

For Union Types, is_a? functionality is delegated to the wrapped member.



158
159
160
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 158

def is_a?(obj)
  @member.is_a?(obj)
end

#kind_of? ⇒ Object 



29
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 29

alias kind_of? is_a?

#to_json(*_args) ⇒ String

For Union Types, to_json functionality is delegated to the wrapped member.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 81

def to_json(*_args)
  case @discriminant
  when "workflow.node.started"
    { **@member.to_json, type: @discriminant }.to_json
  when "conversation-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "hang"
    { **@member.to_json, type: @discriminant }.to_json
  when "metadata"
    { **@member.to_json, type: @discriminant }.to_json
  when "model-output"
    { **@member.to_json, type: @discriminant }.to_json
  when "speech-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "transcript[transcriptType='final']"
    { **@member.to_json, type: @discriminant }.to_json
  when "tool-calls"
    { **@member.to_json, type: @discriminant }.to_json
  when "tool-calls-result"
    { **@member.to_json, type: @discriminant }.to_json
  when "transfer-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "user-interrupted"
    { **@member.to_json, type: @discriminant }.to_json
  when "language-change-detected"
    { **@member.to_json, type: @discriminant }.to_json
  when "voice-input"
    { **@member.to_json, type: @discriminant }.to_json
  else
    { "type": @discriminant, value: @member }.to_json
  end
  @member.to_json
end