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

Parameters:

  • member (Object)
  • discriminant (String) 


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

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

Instance Attribute Details

#discriminant ⇒ String (readonly)

Returns:

  • (String) 


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

def discriminant
  @discriminant
end

#member ⇒ Object (readonly)

Returns:

  • (Object) 


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

def member
  @member
end

Class Method Details

.conversation_update(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

Parameters:

  • json_object (String)

Returns:



42
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
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 42

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           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"
             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::ClientMessageConversationUpdate.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.hang(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.language_change_detected(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.metadata(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.model_output(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.speech_update(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.tool_calls(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.tool_calls_result(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.transcript(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.transfer_update(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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

.user_interrupted(member:) ⇒ Vapi::ClientMessageMessage

Parameters:

Returns:



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

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.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


116
117
118
119
120
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
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 116

def self.validate_raw(obj:)
  case obj.type
  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"
    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

Parameters:

Returns:



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

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

Instance Method Details

#is_a?(obj) ⇒ Boolean

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

Parameters:

  • obj (Object)

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 151

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

#kind_of? ⇒ Object 



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

alias kind_of? is_a?

#to_json(*_args) ⇒ String

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

Returns:

  • (String) 


78
79
80
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
 
# File 'lib/vapi_server_sdk/types/client_message_message.rb', line 78

def to_json(*_args)
  case @discriminant
  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"
    { **@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