Class: Freeclimb::RecordUtterance

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

Overview

The ‘RecordUtterance` command records the caller’s voice and returns the URL of a file containing the audio recording. ‘RecordUtterance` 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 to the `actionUrl`. Recording information is returned in the `actionUrl` request.

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 = {}) ⇒ RecordUtterance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
121
122
123
124
125
126
127
 
# File 'lib/freeclimb/models/record_utterance.rb', line 83

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::RecordUtterance` 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::RecordUtterance`. 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

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

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

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

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

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

  if attributes.key?(:privacy_mode)
    self.privacy_mode = attributes[:privacy_mode]
  end
  self.command = "RecordUtterance"
end

Instance Attribute Details

#action_url ⇒ Object

URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing.



18
19
20
 
# File 'lib/freeclimb/models/record_utterance.rb', line 18

def action_url
  @action_url
end

#auto_start ⇒ Object

If ‘false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated.



33
34
35
 
# File 'lib/freeclimb/models/record_utterance.rb', line 33

def auto_start
  @auto_start
end

#finish_on_key ⇒ Object

Key that triggers the end of the recording. any digit, ‘#’, or ‘*’



24
25
26
 
# File 'lib/freeclimb/models/record_utterance.rb', line 24

def finish_on_key
  @finish_on_key
end

#max_length_sec ⇒ Object

Maximum length for the command execution in seconds.



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

def max_length_sec
  @max_length_sec
end

#play_beep ⇒ Object

Indicates whether to play a beep sound before the start of the recording. If set to ‘false`, no beep is played.



30
31
32
 
# File 'lib/freeclimb/models/record_utterance.rb', line 30

def play_beep
  @play_beep
end

#privacy_mode ⇒ Object

Parameter ‘privacyMode` will not log the `text` as required by PCI compliance.



36
37
38
 
# File 'lib/freeclimb/models/record_utterance.rb', line 36

def privacy_mode
  @privacy_mode
end

#silence_timeout_ms ⇒ Object

Interval of silence that should elapse before ending the recording.



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

def silence_timeout_ms
  @silence_timeout_ms
end

Class Method Details

.acceptable_attributes ⇒ Object

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



52
53
54
 
# File 'lib/freeclimb/models/record_utterance.rb', line 52

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.



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/freeclimb/models/record_utterance.rb', line 39

def self.attribute_map
  {
    action_url: :actionUrl,
    silence_timeout_ms: :silenceTimeoutMs,
    finish_on_key: :finishOnKey,
    max_length_sec: :maxLengthSec,
    play_beep: :playBeep,
    auto_start: :autoStart,
    privacy_mode: :privacyMode
  }
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



179
180
181
 
# File 'lib/freeclimb/models/record_utterance.rb', line 179

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



75
76
77
78
79
 
# File 'lib/freeclimb/models/record_utterance.rb', line 75

def self.openapi_all_of
  [
    :PerclCommand
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
 
# File 'lib/freeclimb/models/record_utterance.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/freeclimb/models/record_utterance.rb', line 57

def self.openapi_types
  {
    action_url: :String,
    silence_timeout_ms: :Integer,
    finish_on_key: :String,
    max_length_sec: :Integer,
    play_beep: :Boolean,
    auto_start: :Boolean,
    privacy_mode: :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/freeclimb/models/record_utterance.rb', line 152

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    action_url == other.action_url &&
    silence_timeout_ms == other.silence_timeout_ms &&
    finish_on_key == other.finish_on_key &&
    max_length_sec == other.max_length_sec &&
    play_beep == other.play_beep &&
    auto_start == other.auto_start &&
    privacy_mode == other.privacy_mode && 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



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
240
241
242
243
244
245
246
247
 
# File 'lib/freeclimb/models/record_utterance.rb', line 210

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



281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/freeclimb/models/record_utterance.rb', line 281

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/freeclimb/models/record_utterance.rb', line 186

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


166
167
168
 
# File 'lib/freeclimb/models/record_utterance.rb', line 166

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



172
173
174
 
# File 'lib/freeclimb/models/record_utterance.rb', line 172

def hash
  [action_url, silence_timeout_ms, finish_on_key, max_length_sec, play_beep, auto_start, privacy_mode].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



131
132
133
134
135
136
137
138
 
# File 'lib/freeclimb/models/record_utterance.rb', line 131

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



257
258
259
 
# File 'lib/freeclimb/models/record_utterance.rb', line 257

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/freeclimb/models/record_utterance.rb', line 263

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



251
252
253
 
# File 'lib/freeclimb/models/record_utterance.rb', line 251

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



142
143
144
145
146
147
148
 
# File 'lib/freeclimb/models/record_utterance.rb', line 142

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