Class: Freeclimb::TranscribeUtterance

Inherits:
PerclCommand show all
Defined in:
lib/freeclimb/models/transcribe_utterance.rb

Overview

The ‘TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed. `TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.

Instance Attribute Summary collapse

Attributes inherited from PerclCommand

#command

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerclCommand

openapi_discriminator_name, #to_percl_hash

Constructor Details

#initialize(attributes = {}) ⇒ TranscribeUtterance

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 72

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::TranscribeUtterance` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if !self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::TranscribeUtterance`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super

  if attributes.key?(:action_url)
    self.action_url = attributes[:action_url]
  end

  self.play_beep = if attributes.key?(:play_beep)
    attributes[:play_beep]
  else
    false
  end

  if attributes.key?(:record)
    self.record = attributes[:record]
  end

  self.privacy_for_logging = if attributes.key?(:privacy_for_logging)
    attributes[:privacy_for_logging]
  else
    false
  end

  self.privacy_for_recording = if attributes.key?(:privacy_for_recording)
    attributes[:privacy_for_recording]
  else
    false
  end

  if attributes.key?(:prompts)
    if (value = attributes[:prompts]).is_a?(Array)
      self.prompts = value
    end
  end
  self.command = "TranscribeUtterance"
end

Instance Attribute Details

#action_url ⇒ Object

Returns the value of attribute action_url.



17
18
19
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 17

def action_url
  @action_url
end

#play_beep ⇒ Object

Returns the value of attribute play_beep.



19
20
21
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 19

def play_beep
  @play_beep
end

#privacy_for_logging ⇒ Object

Returns the value of attribute privacy_for_logging.



23
24
25
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 23

def privacy_for_logging
  @privacy_for_logging
end

#privacy_for_recording ⇒ Object

Returns the value of attribute privacy_for_recording.



25
26
27
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 25

def privacy_for_recording
  @privacy_for_recording
end

#prompts ⇒ Object

Returns the value of attribute prompts.



27
28
29
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 27

def prompts
  @prompts
end

#record ⇒ Object

Returns the value of attribute record.



21
22
23
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 21

def record
  @record
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



42
43
44
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 42

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 30

def self.attribute_map
  {
    action_url: :actionUrl,
    play_beep: :playBeep,
    record: :record,
    privacy_for_logging: :privacyForLogging,
    privacy_for_recording: :privacyForRecording,
    prompts: :prompts
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



171
172
173
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 171

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



64
65
66
67
68
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 64

def self.openapi_all_of
  [
    :PerclCommand
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 59

def self.openapi_nullable
  Set.new([])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 47

def self.openapi_types
  {
    action_url: :String,
    play_beep: :Boolean,
    record: :TranscribeUtteranceRecord,
    privacy_for_logging: :Boolean,
    privacy_for_recording: :Boolean,
    prompts: :"Array<PerclCommand>"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 145

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    action_url == other.action_url &&
    play_beep == other.play_beep &&
    record == other.record &&
    privacy_for_logging == other.privacy_for_logging &&
    privacy_for_recording == other.privacy_for_recording &&
    prompts == other.prompts && super
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 202

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 273

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 178

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send(:"#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


158
159
160
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



164
165
166
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 164

def hash
  [action_url, play_beep, record, privacy_for_logging, privacy_for_recording, prompts].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



124
125
126
127
128
129
130
131
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 124

def list_invalid_properties
  invalid_properties = super
  if @action_url.nil?
    invalid_properties.push('invalid value for "action_url", action_url cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



249
250
251
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 249

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 255

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



243
244
245
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 243

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



135
136
137
138
139
140
141
 
# File 'lib/freeclimb/models/transcribe_utterance.rb', line 135

def valid?
  if @action_url.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end