Class: Vapi::VapiVoice

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(voice_id:, caching_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, fallback_plan: OMIT, additional_properties: nil) ⇒ Vapi::VapiVoice 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 42

def initialize(voice_id:, caching_enabled: OMIT, speed: OMIT, chunk_plan: OMIT, fallback_plan: OMIT,
               additional_properties: nil)
  @caching_enabled = caching_enabled if caching_enabled != OMIT
  @voice_id = voice_id
  @speed = speed if speed != OMIT
  @chunk_plan = chunk_plan if chunk_plan != OMIT
  @fallback_plan = fallback_plan if fallback_plan != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "cachingEnabled": caching_enabled,
    "voiceId": voice_id,
    "speed": speed,
    "chunkPlan": chunk_plan,
    "fallbackPlan": fallback_plan
  }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly) 



25
26
27
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 25

def additional_properties
  @additional_properties
end

#caching_enabled ⇒ Boolean (readonly) 



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

def caching_enabled
  @caching_enabled
end

#chunk_plan ⇒ Vapi::ChunkPlan (readonly) 



20
21
22
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 20

def chunk_plan
  @chunk_plan
end

#fallback_plan ⇒ Vapi::FallbackPlan (readonly) 



23
24
25
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 23

def fallback_plan
  @fallback_plan
end

#speed ⇒ Float (readonly) 



17
18
19
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 17

def speed
  @speed
end

#voice_id ⇒ Vapi::VapiVoiceVoiceId (readonly) 



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

def voice_id
  @voice_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::VapiVoice

Deserialize a JSON object to an instance of VapiVoice



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 65

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  caching_enabled = parsed_json["cachingEnabled"]
  voice_id = parsed_json["voiceId"]
  speed = parsed_json["speed"]
  if parsed_json["chunkPlan"].nil?
    chunk_plan = nil
  else
    chunk_plan = parsed_json["chunkPlan"].to_json
    chunk_plan = Vapi::ChunkPlan.from_json(json_object: chunk_plan)
  end
  if parsed_json["fallbackPlan"].nil?
    fallback_plan = nil
  else
    fallback_plan = parsed_json["fallbackPlan"].to_json
    fallback_plan = Vapi::FallbackPlan.from_json(json_object: fallback_plan)
  end
  new(
    caching_enabled: caching_enabled,
    voice_id: voice_id,
    speed: speed,
    chunk_plan: chunk_plan,
    fallback_plan: fallback_plan,
    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.



106
107
108
109
110
111
112
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 106

def self.validate_raw(obj:)
  obj.caching_enabled&.is_a?(Boolean) != false || raise("Passed value for field obj.caching_enabled is not the expected type, validation failed.")
  obj.voice_id.is_a?(Vapi::VapiVoiceVoiceId) != false || raise("Passed value for field obj.voice_id is not the expected type, validation failed.")
  obj.speed&.is_a?(Float) != false || raise("Passed value for field obj.speed is not the expected type, validation failed.")
  obj.chunk_plan.nil? || Vapi::ChunkPlan.validate_raw(obj: obj.chunk_plan)
  obj.fallback_plan.nil? || Vapi::FallbackPlan.validate_raw(obj: obj.fallback_plan)
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of VapiVoice to a JSON object



96
97
98
 
# File 'lib/vapi_server_sdk/types/vapi_voice.rb', line 96

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