Class: Bandwidth::TranscriptionResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/bandwidth/voice_lib/voice/models/transcription_response.rb

Overview

TranscriptionResponse Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(transcripts = nil) ⇒ TranscriptionResponse

Returns a new instance of TranscriptionResponse.



35
36
37
 
# File 'lib/bandwidth/voice_lib/voice/models/transcription_response.rb', line 35

def initialize(transcripts = nil)
  @transcripts = transcripts unless transcripts == SKIP
end

Instance Attribute Details

#transcripts ⇒ List of Transcript

TODO: Write general description for this method

Returns:



14
15
16
 
# File 'lib/bandwidth/voice_lib/voice/models/transcription_response.rb', line 14

def transcripts
  @transcripts
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/bandwidth/voice_lib/voice/models/transcription_response.rb', line 40

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  transcripts = nil
  unless hash['transcripts'].nil?
    transcripts = []
    hash['transcripts'].each do |structure|
      transcripts << (Transcript.from_hash(structure) if structure)
    end
  end

  transcripts = SKIP unless hash.key?('transcripts')

  # Create object from extracted values.
  TranscriptionResponse.new(transcripts)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/bandwidth/voice_lib/voice/models/transcription_response.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['transcripts'] = 'transcripts'
  @_hash
end

Instance Method Details

#nullables ⇒ Object

An array for nullable fields



31
32
33
 
# File 'lib/bandwidth/voice_lib/voice/models/transcription_response.rb', line 31

def nullables
  []
end

#optionals ⇒ Object

An array for optional fields



24
25
26
27
28
 
# File 'lib/bandwidth/voice_lib/voice/models/transcription_response.rb', line 24

def optionals
  %w[
    transcripts
  ]
end