Class: Freeclimb::GetDigits

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

Overview

The ‘GetDigits` command collects DTMF inputs from the caller. It is only supported only when there is a single party on the Call. `GetDigits` is a Terminal Command — any actions following it are never executed. When the Caller is done entering the digits, FreeClimb submits that data to the provided `actionUrl` using an HTTP POST request. Your server will be required to respond to the FreeClimb Webhook with PerCL to continue handling the call.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/freeclimb/models/get_digits.rb', line 93

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

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

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

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

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

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

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

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

Instance Attribute Details

#action_url ⇒ Object

When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL.



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

def action_url
  @action_url
end

#digit_timeout_ms ⇒ Object

Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a ‘timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered.



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

def digit_timeout_ms
  @digit_timeout_ms
end

#finish_on_key ⇒ Object

Digit that causes the input sequence to be deemed complete. This attribute defers to the ‘timeout` attribute – so, if a `timeout` occurs, then the command terminates regardless of the value of `finishOnKey`.



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

def finish_on_key
  @finish_on_key
end

#flush_buffer ⇒ Object

If set to true, the FreeClimb platform starts with an empty DTMF buffer to store the digits entered by the caller. If set to false, FreeClimb will append the user inputs to the end of the existing digits buffer and will return digits from the start of the digits buffer.



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

def flush_buffer
  @flush_buffer
end

#initial_timeout_ms ⇒ Object

Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a ‘timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed.



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

def initial_timeout_ms
  @initial_timeout_ms
end

#max_digits ⇒ Object

Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the ‘GetDigits` command terminates regardless of the value of `finishOnKey`.



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

def max_digits
  @max_digits
end

#min_digits ⇒ Object

Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits.



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

def min_digits
  @min_digits
end

#privacy_mode ⇒ Object

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



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

def privacy_mode
  @privacy_mode
end

#prompts ⇒ Object

JSON array of PerCL commands to nest within the ‘GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller.



39
40
41
 
# File 'lib/freeclimb/models/get_digits.rb', line 39

def prompts
  @prompts
end

Class Method Details

.acceptable_attributes ⇒ Object

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



60
61
62
 
# File 'lib/freeclimb/models/get_digits.rb', line 60

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.



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

def self.attribute_map
  {
    action_url: :actionUrl,
    digit_timeout_ms: :digitTimeoutMs,
    finish_on_key: :finishOnKey,
    flush_buffer: :flushBuffer,
    initial_timeout_ms: :initialTimeoutMs,
    max_digits: :maxDigits,
    min_digits: :minDigits,
    prompts: :prompts,
    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



201
202
203
 
# File 'lib/freeclimb/models/get_digits.rb', line 201

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



85
86
87
88
89
 
# File 'lib/freeclimb/models/get_digits.rb', line 85

def self.openapi_all_of
  [
    :PerclCommand
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
 
# File 'lib/freeclimb/models/get_digits.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/freeclimb/models/get_digits.rb', line 65

def self.openapi_types
  {
    action_url: :String,
    digit_timeout_ms: :Integer,
    finish_on_key: :String,
    flush_buffer: :Boolean,
    initial_timeout_ms: :Integer,
    max_digits: :Integer,
    min_digits: :Integer,
    prompts: :"Array<PerclCommand>",
    privacy_mode: :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/freeclimb/models/get_digits.rb', line 172

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    action_url == other.action_url &&
    digit_timeout_ms == other.digit_timeout_ms &&
    finish_on_key == other.finish_on_key &&
    flush_buffer == other.flush_buffer &&
    initial_timeout_ms == other.initial_timeout_ms &&
    max_digits == other.max_digits &&
    min_digits == other.min_digits &&
    prompts == other.prompts &&
    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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/freeclimb/models/get_digits.rb', line 232

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/freeclimb/models/get_digits.rb', line 303

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/freeclimb/models/get_digits.rb', line 208

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


188
189
190
 
# File 'lib/freeclimb/models/get_digits.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



194
195
196
 
# File 'lib/freeclimb/models/get_digits.rb', line 194

def hash
  [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts, 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



151
152
153
154
155
156
157
158
 
# File 'lib/freeclimb/models/get_digits.rb', line 151

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



279
280
281
 
# File 'lib/freeclimb/models/get_digits.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/freeclimb/models/get_digits.rb', line 285

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



273
274
275
 
# File 'lib/freeclimb/models/get_digits.rb', line 273

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



162
163
164
165
166
167
168
 
# File 'lib/freeclimb/models/get_digits.rb', line 162

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