class Freeclimb::GetDigits
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.
Attributes
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.
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.
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`.
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.
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`.
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.
Parameter `privacyMode` will not log the `text` as required by PCI compliance.
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.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/freeclimb/models/get_digits.rb, line 46 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/freeclimb/models/get_digits.rb, line 195 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/freeclimb/models/get_digits.rb, line 91 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(attributes) 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 end
List of class defined in allOf (OpenAPI v3)
# File lib/freeclimb/models/get_digits.rb, line 82 def self.openapi_all_of [ :'GetDigitsAllOf', :'PerclCommand' ] end
List of attributes with nullable: true
# File lib/freeclimb/models/get_digits.rb, line 76 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/freeclimb/models/get_digits.rb, line 61 def self.openapi_types { :'action_url' => :'String', :'digit_timeout_ms' => :'Integer', :'finish_on_key' => :'String', :'flush_buffer' => :'Boolean', :'initial_timeout_ms' => :'String', :'max_digits' => :'Integer', :'min_digits' => :'Integer', :'prompts' => :'Array<PerclCommand>', :'privacy_mode' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/freeclimb/models/get_digits.rb, line 166 def ==(o) return true if self.equal?(o) self.class == o.class && action_url == o.action_url && digit_timeout_ms == o.digit_timeout_ms && finish_on_key == o.finish_on_key && flush_buffer == o.flush_buffer && initial_timeout_ms == o.initial_timeout_ms && max_digits == o.max_digits && min_digits == o.min_digits && prompts == o.prompts && privacy_mode == o.privacy_mode && super(o) end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/freeclimb/models/get_digits.rb, line 224 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.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 Freeclimb.const_get(type).build_from_hash(value) end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/freeclimb/models/get_digits.rb, line 293 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/freeclimb/models/get_digits.rb, line 202 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) super(attributes) self.class.openapi_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/freeclimb/models/get_digits.rb, line 182 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/freeclimb/models/get_digits.rb, line 188 def hash [action_url, digit_timeout_ms, finish_on_key, flush_buffer, initial_timeout_ms, max_digits, min_digits, prompts, privacy_mode].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/freeclimb/models/get_digits.rb, line 148 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/freeclimb/models/get_digits.rb, line 275 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/freeclimb/models/get_digits.rb, line 263 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/freeclimb/models/get_digits.rb, line 159 def valid? return false if @action_url.nil? true && super end