Class: Vapi::AssistantHookFilter

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(type:, key:, one_of:, additional_properties: nil) ⇒ Vapi::AssistantHookFilter

Parameters:

  • type (String) —

    This is the type of filter - currently only “oneOf” is supported

  • key (String) —

    This is the key to filter on (e.g. “call.endedReason”)

  • one_of (Array<String>) —

    This is the array of possible values to match against

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

    Additional properties unmapped to the current class definition



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

def initialize(type:, key:, one_of:, additional_properties: nil)
  @type = type
  @key = key
  @one_of = one_of
  @additional_properties = additional_properties
  @_field_set = { "type": type, "key": key, "oneOf": one_of }
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_filter.rb', line 15

def additional_properties
  @additional_properties
end

#key ⇒ String (readonly)

Returns This is the key to filter on (e.g. “call.endedReason”).

Returns:

  • (String) —

    This is the key to filter on (e.g. “call.endedReason”)



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

def key
  @key
end

#one_of ⇒ Array<String> (readonly)

Returns This is the array of possible values to match against.

Returns:

  • (Array<String>) —

    This is the array of possible values to match against



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

def one_of
  @one_of
end

#type ⇒ String (readonly)

Returns This is the type of filter - currently only “oneOf” is supported.

Returns:

  • (String) —

    This is the type of filter - currently only “oneOf” is supported



9
10
11
 
# File 'lib/vapi_server_sdk/types/assistant_hook_filter.rb', line 9

def type
  @type
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::AssistantHookFilter

Deserialize a JSON object to an instance of AssistantHookFilter

Parameters:

  • json_object (String)

Returns:



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

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  type = parsed_json["type"]
  key = parsed_json["key"]
  one_of = parsed_json["oneOf"]
  new(
    type: type,
    key: key,
    one_of: one_of,
    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
70
 
# File 'lib/vapi_server_sdk/types/assistant_hook_filter.rb', line 66

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of AssistantHookFilter to a JSON object

Returns:

  • (String) 


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

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