Class: Vapi::Edge

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(from:, to:, condition: OMIT, metadata: OMIT, additional_properties: nil) ⇒ Vapi::Edge

Parameters:

  • condition (Vapi::AiEdgeCondition) (defaults to: OMIT)
  • from (String)
  • to (String)
  • metadata (Hash{String => Object}) (defaults to: OMIT) —

    This is for metadata you want to store on the edge.

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

    Additional properties unmapped to the current class definition



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/vapi_server_sdk/types/edge.rb', line 31

def initialize(from:, to:, condition: OMIT, metadata: OMIT, additional_properties: nil)
  @condition = condition if condition != OMIT
  @from = from
  @to = to
  @metadata = metadata if metadata != OMIT
  @additional_properties = additional_properties
  @_field_set = { "condition": condition, "from": from, "to": to, "metadata": metadata }.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



18
19
20
 
# File 'lib/vapi_server_sdk/types/edge.rb', line 18

def additional_properties
  @additional_properties
end

#condition ⇒ Vapi::AiEdgeCondition (readonly)

Returns:



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

def condition
  @condition
end

#from ⇒ String (readonly)

Returns:

  • (String) 


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

def from
  @from
end

#metadata ⇒ Hash{String => Object} (readonly)

Returns This is for metadata you want to store on the edge.

Returns:

  • (Hash{String => Object}) —

    This is for metadata you want to store on the edge.



16
17
18
 
# File 'lib/vapi_server_sdk/types/edge.rb', line 16

def metadata
  @metadata
end

#to ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/vapi_server_sdk/types/edge.rb', line 14

def to
  @to
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::Edge

Deserialize a JSON object to an instance of Edge

Parameters:

  • json_object (String)

Returns:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/vapi_server_sdk/types/edge.rb', line 46

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["condition"].nil?
    condition = nil
  else
    condition = parsed_json["condition"].to_json
    condition = Vapi::AiEdgeCondition.from_json(json_object: condition)
  end
  from = parsed_json["from"]
  to = parsed_json["to"]
  metadata = parsed_json["metadata"]
  new(
    condition: condition,
    from: from,
    to: to,
    metadata: metadata,
    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) 


80
81
82
83
84
85
 
# File 'lib/vapi_server_sdk/types/edge.rb', line 80

def self.validate_raw(obj:)
  obj.condition.nil? || Vapi::AiEdgeCondition.validate_raw(obj: obj.condition)
  obj.from.is_a?(String) != false || raise("Passed value for field obj.from is not the expected type, validation failed.")
  obj.to.is_a?(String) != false || raise("Passed value for field obj.to is not the expected type, validation failed.")
  obj.metadata&.is_a?(Hash) != false || raise("Passed value for field obj.metadata is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of Edge to a JSON object

Returns:

  • (String) 


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

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