Class: Vapi::ServerMessageMessage

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

Overview

These are all the messages that can be sent to your server before, after and during the call. Configure the messages you'd like to receive in assistant.serverMessages. The server where the message is sent is determined by the following precedence order:

  1. tool.server.url (if configured, and only for "tool-calls" message)
  2. assistant.serverUrl (if configure)
  3. phoneNumber.serverUrl (if configured)
  4. org.serverUrl (if configured)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

  • member (Object)
  • discriminant (String) 


44
45
46
47
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 44

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

Instance Attribute Details

#discriminant ⇒ String (readonly)

Returns:

  • (String) 


36
37
38
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 36

def discriminant
  @discriminant
end

#member ⇒ Object (readonly)

Returns:

  • (Object) 


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

def member
  @member
end

Class Method Details

.assistant_request(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



198
199
200
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 198

def self.assistant_request(member:)
  new(member: member, discriminant: "assistant-request")
end

.conversation_update(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



204
205
206
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 204

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

.end_of_call_report(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



210
211
212
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 210

def self.end_of_call_report(member:)
  new(member: member, discriminant: "end-of-call-report")
end

.from_json(json_object:) ⇒ Vapi::ServerMessageMessage

Deserialize a JSON object to an instance of ServerMessageMessage

Parameters:

  • json_object (String)

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 53

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           when "assistant-request"
             Vapi::ServerMessageAssistantRequest.from_json(json_object: json_object)
           when "conversation-update"
             Vapi::ServerMessageConversationUpdate.from_json(json_object: json_object)
           when "end-of-call-report"
             Vapi::ServerMessageEndOfCallReport.from_json(json_object: json_object)
           when "hang"
             Vapi::ServerMessageHang.from_json(json_object: json_object)
           when "knowledge-base-request"
             Vapi::ServerMessageKnowledgeBaseRequest.from_json(json_object: json_object)
           when "model-output"
             Vapi::ServerMessageModelOutput.from_json(json_object: json_object)
           when "phone-call-control"
             Vapi::ServerMessagePhoneCallControl.from_json(json_object: json_object)
           when "speech-update"
             Vapi::ServerMessageSpeechUpdate.from_json(json_object: json_object)
           when "status-update"
             Vapi::ServerMessageStatusUpdate.from_json(json_object: json_object)
           when "tool-calls"
             Vapi::ServerMessageToolCalls.from_json(json_object: json_object)
           when "transfer-destination-request"
             Vapi::ServerMessageTransferDestinationRequest.from_json(json_object: json_object)
           when "transfer-update"
             Vapi::ServerMessageTransferUpdate.from_json(json_object: json_object)
           when "transcript"
             Vapi::ServerMessageTranscript.from_json(json_object: json_object)
           when "user-interrupted"
             Vapi::ServerMessageUserInterrupted.from_json(json_object: json_object)
           when "language-change-detected"
             Vapi::ServerMessageLanguageChangeDetected.from_json(json_object: json_object)
           when "voice-input"
             Vapi::ServerMessageVoiceInput.from_json(json_object: json_object)
           when "voice-request"
             Vapi::ServerMessageVoiceRequest.from_json(json_object: json_object)
           else
             Vapi::ServerMessageAssistantRequest.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.hang(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



216
217
218
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 216

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

.knowledge_base_request(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



222
223
224
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 222

def self.knowledge_base_request(member:)
  new(member: member, discriminant: "knowledge-base-request")
end

.language_change_detected(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



282
283
284
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 282

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

.model_output(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



228
229
230
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 228

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

.phone_call_control(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



234
235
236
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 234

def self.phone_call_control(member:)
  new(member: member, discriminant: "phone-call-control")
end

.speech_update(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



240
241
242
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 240

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

.status_update(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



246
247
248
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 246

def self.status_update(member:)
  new(member: member, discriminant: "status-update")
end

.tool_calls(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



252
253
254
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 252

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

.transcript(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



270
271
272
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 270

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

.transfer_destination_request(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



258
259
260
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 258

def self.transfer_destination_request(member:)
  new(member: member, discriminant: "transfer-destination-request")
end

.transfer_update(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



264
265
266
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 264

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

.user_interrupted(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



276
277
278
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 276

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) 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 147

def self.validate_raw(obj:)
  case obj.type
  when "assistant-request"
    Vapi::ServerMessageAssistantRequest.validate_raw(obj: obj)
  when "conversation-update"
    Vapi::ServerMessageConversationUpdate.validate_raw(obj: obj)
  when "end-of-call-report"
    Vapi::ServerMessageEndOfCallReport.validate_raw(obj: obj)
  when "hang"
    Vapi::ServerMessageHang.validate_raw(obj: obj)
  when "knowledge-base-request"
    Vapi::ServerMessageKnowledgeBaseRequest.validate_raw(obj: obj)
  when "model-output"
    Vapi::ServerMessageModelOutput.validate_raw(obj: obj)
  when "phone-call-control"
    Vapi::ServerMessagePhoneCallControl.validate_raw(obj: obj)
  when "speech-update"
    Vapi::ServerMessageSpeechUpdate.validate_raw(obj: obj)
  when "status-update"
    Vapi::ServerMessageStatusUpdate.validate_raw(obj: obj)
  when "tool-calls"
    Vapi::ServerMessageToolCalls.validate_raw(obj: obj)
  when "transfer-destination-request"
    Vapi::ServerMessageTransferDestinationRequest.validate_raw(obj: obj)
  when "transfer-update"
    Vapi::ServerMessageTransferUpdate.validate_raw(obj: obj)
  when "transcript"
    Vapi::ServerMessageTranscript.validate_raw(obj: obj)
  when "user-interrupted"
    Vapi::ServerMessageUserInterrupted.validate_raw(obj: obj)
  when "language-change-detected"
    Vapi::ServerMessageLanguageChangeDetected.validate_raw(obj: obj)
  when "voice-input"
    Vapi::ServerMessageVoiceInput.validate_raw(obj: obj)
  when "voice-request"
    Vapi::ServerMessageVoiceRequest.validate_raw(obj: obj)
  else
    raise("Passed value matched no type within the union, validation failed.")
  end
end

.voice_input(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



288
289
290
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 288

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

.voice_request(member:) ⇒ Vapi::ServerMessageMessage

Parameters:

Returns:



294
295
296
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 294

def self.voice_request(member:)
  new(member: member, discriminant: "voice-request")
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) 


192
193
194
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 192

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

#kind_of? ⇒ Object 



39
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 39

alias kind_of? is_a?

#to_json(*_args) ⇒ String

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

Returns:

  • (String) 


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/vapi_server_sdk/types/server_message_message.rb', line 99

def to_json(*_args)
  case @discriminant
  when "assistant-request"
    { **@member.to_json, type: @discriminant }.to_json
  when "conversation-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "end-of-call-report"
    { **@member.to_json, type: @discriminant }.to_json
  when "hang"
    { **@member.to_json, type: @discriminant }.to_json
  when "knowledge-base-request"
    { **@member.to_json, type: @discriminant }.to_json
  when "model-output"
    { **@member.to_json, type: @discriminant }.to_json
  when "phone-call-control"
    { **@member.to_json, type: @discriminant }.to_json
  when "speech-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "status-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "tool-calls"
    { **@member.to_json, type: @discriminant }.to_json
  when "transfer-destination-request"
    { **@member.to_json, type: @discriminant }.to_json
  when "transfer-update"
    { **@member.to_json, type: @discriminant }.to_json
  when "transcript"
    { **@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
  when "voice-request"
    { **@member.to_json, type: @discriminant }.to_json
  else
    { "type": @discriminant, value: @member }.to_json
  end
  @member.to_json
end