Class: Vapi::ClientInboundMessageControl

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

Constant Summary collapse

OMIT =
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(control:, additional_properties: nil) ⇒ Vapi::ClientInboundMessageControl

Parameters:

  • control (Vapi::ClientInboundMessageControlControl)

    This is the control action

  • additional_properties (OpenStruct) (defaults to: nil)

    Additional properties unmapped to the current class definition



22
23
24
25
26
# File 'lib/vapi_server_sdk/types/client_inbound_message_control.rb', line 22

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

Instance Attribute Details

#additional_propertiesOpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct)

    Additional properties unmapped to the current class definition



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

def additional_properties
  @additional_properties
end

#controlVapi::ClientInboundMessageControlControl (readonly)

Returns This is the control action.

Returns:



10
11
12
# File 'lib/vapi_server_sdk/types/client_inbound_message_control.rb', line 10

def control
  @control
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ClientInboundMessageControl

Deserialize a JSON object to an instance of ClientInboundMessageControl

Parameters:

  • json_object (String)

Returns:



32
33
34
35
36
37
# File 'lib/vapi_server_sdk/types/client_inbound_message_control.rb', line 32

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


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

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ClientInboundMessageControl to a JSON object

Returns:

  • (String)


42
43
44
# File 'lib/vapi_server_sdk/types/client_inbound_message_control.rb', line 42

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