Class: Vapi::ClientInboundMessageMessage

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

Overview

These are the messages that can be sent from client-side SDKs to control the

call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Parameters:

  • member (Object)
  • discriminant (String) 


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

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

Instance Attribute Details

#discriminant ⇒ String (readonly)

Returns:

  • (String) 


17
18
19
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 17

def discriminant
  @discriminant
end

#member ⇒ Object (readonly)

Returns:

  • (Object) 


15
16
17
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 15

def member
  @member
end

Class Method Details

.add_message(member:) ⇒ Vapi::ClientInboundMessageMessage

Parameters:

Returns:



107
108
109
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 107

def self.add_message(member:)
  new(member: member, discriminant: "add-message")
end

.control(member:) ⇒ Vapi::ClientInboundMessageMessage

Parameters:

Returns:



113
114
115
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 113

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

.end_call(member:) ⇒ Vapi::ClientInboundMessageMessage

Parameters:

Returns:



125
126
127
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 125

def self.end_call(member:)
  new(member: member, discriminant: "end-call")
end

.from_json(json_object:) ⇒ Vapi::ClientInboundMessageMessage

Deserialize a JSON object to an instance of ClientInboundMessageMessage

Parameters:

  • json_object (String)

Returns:



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 34

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  member = case struct.type
           when "add-message"
             Vapi::ClientInboundMessageAddMessage.from_json(json_object: json_object)
           when "control"
             Vapi::ClientInboundMessageControl.from_json(json_object: json_object)
           when "say"
             Vapi::ClientInboundMessageSay.from_json(json_object: json_object)
           when "end-call"
             Vapi::ClientInboundMessageEndCall.from_json(json_object: json_object)
           when "transfer"
             Vapi::ClientInboundMessageTransfer.from_json(json_object: json_object)
           else
             Vapi::ClientInboundMessageAddMessage.from_json(json_object: json_object)
           end
  new(member: member, discriminant: struct.type)
end

.say(member:) ⇒ Vapi::ClientInboundMessageMessage

Parameters:

Returns:



119
120
121
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 119

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

.transfer(member:) ⇒ Vapi::ClientInboundMessageMessage

Parameters:

Returns:



131
132
133
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 131

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


80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 80

def self.validate_raw(obj:)
  case obj.type
  when "add-message"
    Vapi::ClientInboundMessageAddMessage.validate_raw(obj: obj)
  when "control"
    Vapi::ClientInboundMessageControl.validate_raw(obj: obj)
  when "say"
    Vapi::ClientInboundMessageSay.validate_raw(obj: obj)
  when "end-call"
    Vapi::ClientInboundMessageEndCall.validate_raw(obj: obj)
  when "transfer"
    Vapi::ClientInboundMessageTransfer.validate_raw(obj: obj)
  else
    raise("Passed value matched no type within the union, validation failed.")
  end
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) 


101
102
103
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 101

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

#kind_of? ⇒ Object 



20
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 20

alias kind_of? is_a?

#to_json(*_args) ⇒ String

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

Returns:

  • (String) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/vapi_server_sdk/types/client_inbound_message_message.rb', line 56

def to_json(*_args)
  case @discriminant
  when "add-message"
    { **@member.to_json, type: @discriminant }.to_json
  when "control"
    { **@member.to_json, type: @discriminant }.to_json
  when "say"
    { **@member.to_json, type: @discriminant }.to_json
  when "end-call"
    { **@member.to_json, type: @discriminant }.to_json
  when "transfer"
    { **@member.to_json, type: @discriminant }.to_json
  else
    { "type": @discriminant, value: @member }.to_json
  end
  @member.to_json
end