Class: Vapi::AssistantBackgroundSound

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

Overview

This is the background sound in the call. Default for phone calls is ‘office’

and default for web calls is 'off'.
You can also provide a custom sound by providing a URL to an audio file.

Class Method Summary collapse

Class Method Details

.from_json(json_object:) ⇒ Vapi::AssistantBackgroundSound

Deserialize a JSON object to an instance of AssistantBackgroundSound

Parameters:

  • json_object (String)

Returns:



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/vapi_server_sdk/types/assistant_background_sound.rb', line 14

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  begin
    struct.is_a?(Vapi::AssistantBackgroundSoundZero) != false || raise("Passed value for field struct is not the expected type, validation failed.")
    return struct unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  begin
    struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
    return struct unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  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) 


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

def self.validate_raw(obj:)
  begin
    return obj.is_a?(Vapi::AssistantBackgroundSoundZero) != false || raise("Passed value for field obj is not the expected type, validation failed.")
  rescue StandardError
    # noop
  end
  begin
    return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
  rescue StandardError
    # noop
  end
  raise("Passed value matched no type within the union, validation failed.")
end