class PureCloud::DialerAction
Attributes
Additional type specification for this DialerAction
.
A map of key-value pairs pertinent to the DialerAction
. Different types of DialerActions require different properties. MODIFY_CONTACT_ATTRIBUTE with an updateOption of SET takes a contact column as the key and accepts any value. SCHEDULE_CALLBACK takes a key 'callbackOffset' that specifies how far in the future the callback should be scheduled, in minutes. SET_CALLER_ID takes two keys: 'callerAddress', which should be the caller id phone number, and 'callerName'. For either key, you can also specify a column on the contact to get the value from. To do this, specify 'contact.Column', where 'Column' is the name of the contact column from which to get the value. SET_SKILLS takes a key 'skills' with an array of skill ids wrapped into a string (Example: {'skills': '['skillIdHere']'} ).
The type of this DialerAction
.
Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 34 def self.attribute_map { :'type' => :'type', :'action_type_name' => :'actionTypeName', :'update_option' => :'updateOption', :'properties' => :'properties' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 65 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'actionTypeName') self.action_type_name = attributes[:'actionTypeName'] end if attributes.has_key?(:'updateOption') self.update_option = attributes[:'updateOption'] end if attributes.has_key?(:'properties') if (value = attributes[:'properties']).is_a?(Array) self.properties = value end end end
Attribute
type mapping.
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 49 def self.swagger_types { :'type' => :'String', :'action_type_name' => :'String', :'update_option' => :'String', :'properties' => :'Hash<String, String>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 218 def ==(o) return true if self.equal?(o) self.class == o.class && type == o.type && action_type_name == o.action_type_name && update_option == o.update_option && properties == o.properties end
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 259 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 =~ /^(true|t|yes|y|1)$/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 _model = Object.const_get("PureCloud").const_get(type).new _model.build_from_hash(value) end end
Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 319 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
Custom attribute writer method checking allowed values (enum). @param [Object] action_type_name
Object to be assigned
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 186 def action_type_name=(action_type_name) allowed_values = ["DO_NOT_DIAL", "MODIFY_CONTACT_ATTRIBUTE", "SWITCH_TO_PREVIEW", "APPEND_NUMBER_TO_DNC_LIST", "SCHEDULE_CALLBACK", "CONTACT_UNCALLABLE", "NUMBER_UNCALLABLE", "SET_CALLER_ID", "SET_SKILLS"] if action_type_name && !allowed_values.include?(action_type_name) fail ArgumentError, "invalid value for 'action_type_name', must be one of #{allowed_values}." end @action_type_name = action_type_name end
build the object from hash
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 240 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) else #TODO show warning in debug mode end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) else # data not found in attributes(hash), not an issue as the data can be optional end end self end
@see the `==` method @param [Object] Object to be compared
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 229 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 235 def hash [type, action_type_name, update_option, properties].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 114 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
return the object in the form of hash
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 307 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 297 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 172 def type=(type) allowed_values = ["Action", "modifyContactAttribute"] if type && !allowed_values.include?(type) fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}." end @type = type end
Custom attribute writer method checking allowed values (enum). @param [Object] update_option
Object to be assigned
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 200 def update_option=(update_option) allowed_values = ["SET", "INCREMENT", "DECREMENT", "CURRENT_TIME"] if update_option && !allowed_values.include?(update_option) fail ArgumentError, "invalid value for 'update_option', must be one of #{allowed_values}." end @update_option = update_option end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/purecloudplatformclientv2/models/dialer_action.rb, line 123 def valid? if @type.nil? return false end allowed_values = ["Action", "modifyContactAttribute"] if @type && !allowed_values.include?(@type) return false end if @action_type_name.nil? return false end allowed_values = ["DO_NOT_DIAL", "MODIFY_CONTACT_ATTRIBUTE", "SWITCH_TO_PREVIEW", "APPEND_NUMBER_TO_DNC_LIST", "SCHEDULE_CALLBACK", "CONTACT_UNCALLABLE", "NUMBER_UNCALLABLE", "SET_CALLER_ID", "SET_SKILLS"] if @action_type_name && !allowed_values.include?(@action_type_name) return false end allowed_values = ["SET", "INCREMENT", "DECREMENT", "CURRENT_TIME"] if @update_option && !allowed_values.include?(@update_option) return false end end