Class: Vapi::ResponseCompletedEvent

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response:, type:, additional_properties: nil) ⇒ Vapi::ResponseCompletedEvent

Parameters:

  • response (Vapi::ResponseObject) —

    The completed response

  • type (String) —

    Event type

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

    Additional properties unmapped to the current class definition



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

def initialize(response:, type:, additional_properties: nil)
  @response = response
  @type = type
  @additional_properties = additional_properties
  @_field_set = { "response": response, "type": type }
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/response_completed_event.rb', line 14

def additional_properties
  @additional_properties
end

#response ⇒ Vapi::ResponseObject (readonly)

Returns The completed response.

Returns:



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

def response
  @response
end

#type ⇒ String (readonly)

Returns Event type.

Returns:

  • (String) —

    Event type



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

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::ResponseCompletedEvent

Deserialize a JSON object to an instance of ResponseCompletedEvent

Parameters:

  • json_object (String)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vapi_server_sdk/types/response_completed_event.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["response"].nil?
    response = nil
  else
    response = parsed_json["response"].to_json
    response = Vapi::ResponseObject.from_json(json_object: response)
  end
  type = parsed_json["type"]
  new(
    response: response,
    type: type,
    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) 


66
67
68
69
 
# File 'lib/vapi_server_sdk/types/response_completed_event.rb', line 66

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of ResponseCompletedEvent to a JSON object

Returns:

  • (String) 


56
57
58
 
# File 'lib/vapi_server_sdk/types/response_completed_event.rb', line 56

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