Class: Vapi::ClientMessage

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(message:, additional_properties: nil) ⇒ Vapi::ClientMessage

Parameters:

  • message (Vapi::ClientMessageMessage) —

    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`.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



26
27
28
29
30
 
# File 'lib/vapi_server_sdk/types/client_message.rb', line 26

def initialize(message:, additional_properties: nil)
  @message = message
  @additional_properties = additional_properties
  @_field_set = { "message": message }
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



14
15
16
 
# File 'lib/vapi_server_sdk/types/client_message.rb', line 14

def additional_properties
  @additional_properties
end

#message ⇒ Vapi::ClientMessageMessage (readonly)

Returns 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`.

Returns:

  • (Vapi::ClientMessageMessage) —

    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`.



12
13
14
 
# File 'lib/vapi_server_sdk/types/client_message.rb', line 12

def message
  @message
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ClientMessage

Deserialize a JSON object to an instance of ClientMessage

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/vapi_server_sdk/types/client_message.rb', line 36

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["message"].nil?
    message = nil
  else
    message = parsed_json["message"].to_json
    message = Vapi::ClientMessageMessage.from_json(json_object: message)
  end
  new(message: message, additional_properties: struct)
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) 


61
62
63
 
# File 'lib/vapi_server_sdk/types/client_message.rb', line 61

def self.validate_raw(obj:)
  Vapi::ClientMessageMessage.validate_raw(obj: obj.message)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ClientMessage to a JSON object

Returns:

  • (String) 


51
52
53
 
# File 'lib/vapi_server_sdk/types/client_message.rb', line 51

def to_json(*_args)
  @_field_set&.to_json
end