Class: Freeclimb::Say

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

Overview

The ‘Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller. `Say` is useful in cases where it’s difficult to pre-record a prompt for any reason. ‘Say` does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/freeclimb/models/say.rb', line 77

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

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

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

  if attributes.key?(:'loop')
    self.loop = attributes[:'loop']
  else
    self.loop = 1
  end

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

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

Instance Attribute Details

#conference_id ⇒ Object

D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error.



29
30
31
 
# File 'lib/freeclimb/models/say.rb', line 29

def conference_id
  @conference_id
end

#language ⇒ Object

Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below.



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

def language
  @language
end

#loop ⇒ Object

Number of times the text is said. Specifying ‘0’ causes the ‘Say` action to loop until the Call is hung up.



26
27
28
 
# File 'lib/freeclimb/models/say.rb', line 26

def loop
  @loop
end

#privacy_mode ⇒ Object

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



32
33
34
 
# File 'lib/freeclimb/models/say.rb', line 32

def privacy_mode
  @privacy_mode
end

#text ⇒ Object

The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped.



20
21
22
 
# File 'lib/freeclimb/models/say.rb', line 20

def text
  @text
end

Class Method Details

.acceptable_attributes ⇒ Object

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



46
47
48
 
# File 'lib/freeclimb/models/say.rb', line 46

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.



35
36
37
38
39
40
41
42
43
 
# File 'lib/freeclimb/models/say.rb', line 35

def self.attribute_map
  {
    :'text' => :'text',
    :'language' => :'language',
    :'loop' => :'loop',
    :'conference_id' => :'conferenceId',
    :'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



174
175
176
 
# File 'lib/freeclimb/models/say.rb', line 174

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



68
69
70
71
72
73
 
# File 'lib/freeclimb/models/say.rb', line 68

def self.openapi_all_of
  [
  :'PerclCommand',
  :'SayAllOf'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/freeclimb/models/say.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/freeclimb/models/say.rb', line 51

def self.openapi_types
  {
    :'text' => :'String',
    :'language' => :'String',
    :'loop' => :'Integer',
    :'conference_id' => :'String',
    :'privacy_mode' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



149
150
151
152
153
154
155
156
157
 
# File 'lib/freeclimb/models/say.rb', line 149

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text == o.text &&
      language == o.language &&
      loop == o.loop &&
      conference_id == o.conference_id &&
      privacy_mode == o.privacy_mode && super(o)
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



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
240
241
242
 
# File 'lib/freeclimb/models/say.rb', line 205

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/freeclimb/models/say.rb', line 276

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/freeclimb/models/say.rb', line 181

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/freeclimb/models/say.rb', line 161

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



167
168
169
 
# File 'lib/freeclimb/models/say.rb', line 167

def hash
  [text, language, loop, conference_id, 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



119
120
121
122
123
124
125
126
 
# File 'lib/freeclimb/models/say.rb', line 119

def list_invalid_properties
  invalid_properties = super
  if @text.nil?
    invalid_properties.push('invalid value for "text", text 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



252
253
254
 
# File 'lib/freeclimb/models/say.rb', line 252

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/freeclimb/models/say.rb', line 258

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



246
247
248
 
# File 'lib/freeclimb/models/say.rb', line 246

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/freeclimb/models/say.rb', line 130

def valid?
  
  if @text.nil?
    false
  elsif @language.nil?
    false
  elsif @loop.nil?
    false
  elsif @conference_id.nil?
    false
  elsif @privacy_mode.nil?
    false
  else
    list_invalid_properties.length() == 0
  end
end