Class: Vapi::CreateSesameVoiceDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(voice_name: OMIT, transcription: OMIT, additional_properties: nil) ⇒ Vapi::CreateSesameVoiceDto

Parameters:

  • voice_name (String) (defaults to: OMIT) —

    The name of the voice.

  • transcription (String) (defaults to: OMIT) —

    The transcript of the utterance.

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

    Additional properties unmapped to the current class definition



24
25
26
27
28
29
30
31
 
# File 'lib/vapi_server_sdk/types/create_sesame_voice_dto.rb', line 24

def initialize(voice_name: OMIT, transcription: OMIT, additional_properties: nil)
  @voice_name = voice_name if voice_name != OMIT
  @transcription = transcription if transcription != OMIT
  @additional_properties = additional_properties
  @_field_set = { "voiceName": voice_name, "transcription": transcription }.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



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

def additional_properties
  @additional_properties
end

#transcription ⇒ String (readonly)

Returns The transcript of the utterance.

Returns:

  • (String) —

    The transcript of the utterance.



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

def transcription
  @transcription
end

#voice_name ⇒ String (readonly)

Returns The name of the voice.

Returns:

  • (String) —

    The name of the voice.



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

def voice_name
  @voice_name
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateSesameVoiceDto

Deserialize a JSON object to an instance of CreateSesameVoiceDto

Parameters:

  • json_object (String)

Returns:



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/vapi_server_sdk/types/create_sesame_voice_dto.rb', line 37

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  voice_name = parsed_json["voiceName"]
  transcription = parsed_json["transcription"]
  new(
    voice_name: voice_name,
    transcription: transcription,
    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) 


62
63
64
65
 
# File 'lib/vapi_server_sdk/types/create_sesame_voice_dto.rb', line 62

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateSesameVoiceDto to a JSON object

Returns:

  • (String) 


52
53
54
 
# File 'lib/vapi_server_sdk/types/create_sesame_voice_dto.rb', line 52

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