Class: Vapi::ClientMessageSpeechUpdate

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(status:, role:, additional_properties: nil) ⇒ Vapi::ClientMessageSpeechUpdate

Parameters:



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

def initialize(status:, role:, additional_properties: nil)
  @status = status
  @role = role
  @additional_properties = additional_properties
  @_field_set = { "status": status, "role": role }
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



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

def additional_properties
  @additional_properties
end

#role ⇒ Vapi::ClientMessageSpeechUpdateRole (readonly)

Returns This is the role which the speech update is for.

Returns:



13
14
15
 
# File 'lib/vapi_server_sdk/types/client_message_speech_update.rb', line 13

def role
  @role
end

#status ⇒ Vapi::ClientMessageSpeechUpdateStatus (readonly)

Returns This is the status of the speech update.

Returns:



11
12
13
 
# File 'lib/vapi_server_sdk/types/client_message_speech_update.rb', line 11

def status
  @status
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ClientMessageSpeechUpdate

Deserialize a JSON object to an instance of ClientMessageSpeechUpdate

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  status = parsed_json["status"]
  role = parsed_json["role"]
  new(
    status: status,
    role: role,
    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) 


62
63
64
65
 
# File 'lib/vapi_server_sdk/types/client_message_speech_update.rb', line 62

def self.validate_raw(obj:)
  obj.status.is_a?(Vapi::ClientMessageSpeechUpdateStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
  obj.role.is_a?(Vapi::ClientMessageSpeechUpdateRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ClientMessageSpeechUpdate to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/vapi_server_sdk/types/client_message_speech_update.rb', line 52

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