Class: Vapi::AssistantHookCallEnding

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(do_:, filters: OMIT, additional_properties: nil) ⇒ Vapi::AssistantHookCallEnding

Parameters:

  • do_ (Array<Vapi::AssistantHookCallEndingDoItem>) —

    This is the set of actions to perform when the hook triggers

  • filters (Array<Vapi::AssistantHookFilter>) (defaults to: OMIT) —

    This is the set of filters that must match for the hook to trigger

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

    Additional properties unmapped to the current class definition



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

def initialize(do_:, filters: OMIT, additional_properties: nil)
  @do_ = do_
  @filters = filters if filters != OMIT
  @additional_properties = additional_properties
  @_field_set = { "do": do_, "filters": filters }.reject do |_k, v|
    v == OMIT
  end
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/assistant_hook_call_ending.rb', line 15

def additional_properties
  @additional_properties
end

#do_ ⇒ Array<Vapi::AssistantHookCallEndingDoItem> (readonly)

Returns This is the set of actions to perform when the hook triggers.

Returns:



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

def do_
  @do_
end

#filters ⇒ Array<Vapi::AssistantHookFilter> (readonly)

Returns This is the set of filters that must match for the hook to trigger.

Returns:



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

def filters
  @filters
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::AssistantHookCallEnding

Deserialize a JSON object to an instance of AssistantHookCallEnding

Parameters:

  • json_object (String)

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/vapi_server_sdk/types/assistant_hook_call_ending.rb', line 39

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  do_ = parsed_json["do"]&.map do |item|
    item = item.to_json
    Vapi::AssistantHookCallEndingDoItem.from_json(json_object: item)
  end
  filters = parsed_json["filters"]&.map do |item|
    item = item.to_json
    Vapi::AssistantHookFilter.from_json(json_object: item)
  end
  new(
    do_: do_,
    filters: filters,
    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) 


70
71
72
73
 
# File 'lib/vapi_server_sdk/types/assistant_hook_call_ending.rb', line 70

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AssistantHookCallEnding to a JSON object

Returns:

  • (String) 


60
61
62
 
# File 'lib/vapi_server_sdk/types/assistant_hook_call_ending.rb', line 60

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