Class: Vapi::FallbackPlan

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(voices:, additional_properties: nil) ⇒ Vapi::FallbackPlan

Parameters:

  • voices (Array<Vapi::FallbackPlanVoicesItem>) —

    This is the list of voices to fallback to in the event that the primary voice provider fails.

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

    Additional properties unmapped to the current class definition



24
25
26
27
28
 
# File 'lib/vapi_server_sdk/types/fallback_plan.rb', line 24

def initialize(voices:, additional_properties: nil)
  @voices = voices
  @additional_properties = additional_properties
  @_field_set = { "voices": voices }
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



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

def additional_properties
  @additional_properties
end

#voices ⇒ Array<Vapi::FallbackPlanVoicesItem> (readonly)

Returns This is the list of voices to fallback to in the event that the primary voice provider fails.

Returns:



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

def voices
  @voices
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::FallbackPlan

Deserialize a JSON object to an instance of FallbackPlan

Parameters:

  • json_object (String)

Returns:



34
35
36
37
38
39
40
41
42
 
# File 'lib/vapi_server_sdk/types/fallback_plan.rb', line 34

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


57
58
59
 
# File 'lib/vapi_server_sdk/types/fallback_plan.rb', line 57

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of FallbackPlan to a JSON object

Returns:

  • (String) 


47
48
49
 
# File 'lib/vapi_server_sdk/types/fallback_plan.rb', line 47

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