Class: PureCloud::DialerAction

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/models/dialer_action.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DialerAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



65
66
67
68
69
70
71
72
73
74
75
76
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
 
# File 'lib/purecloudclient_v2a/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

Instance Attribute Details

#action_type_name ⇒ Object

Additional type specification for this DialerAction.



25
26
27
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 25

def action_type_name
  @action_type_name
end

#properties ⇒ Object

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.



31
32
33
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 31

def properties
  @properties
end

#type ⇒ Object

The type of this DialerAction.



22
23
24
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 22

def type
  @type
end

#update_option ⇒ Object

Specifies how a contact attribute should be updated. Required for MODIFY_CONTACT_ATTRIBUTE.



28
29
30
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 28

def update_option
  @update_option
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 34

def self.attribute_map
  {
    
    :'type' => :'type',
    
    :'action_type_name' => :'actionTypeName',
    
    :'update_option' => :'updateOption',
    
    :'properties' => :'properties'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 49

def self.swagger_types
  {
    
    :'type' => :'String',
    
    :'action_type_name' => :'String',
    
    :'update_option' => :'String',
    
    :'properties' => :'Hash<String, String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



218
219
220
221
222
223
224
225
 
# File 'lib/purecloudclient_v2a/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

#_deserialize(type, value) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/purecloudclient_v2a/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

#_to_hash(value) ⇒ Object

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/purecloudclient_v2a/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

#build_from_hash(attributes) ⇒ Object

build the object from hash



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/purecloudclient_v2a/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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


229
230
231
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 229

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 235

def hash
  [type, action_type_name, update_option, properties].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



114
115
116
117
118
119
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 114

def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



302
303
304
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 302

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



307
308
309
310
311
312
313
314
315
 
# File 'lib/purecloudclient_v2a/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

#to_s ⇒ Object 



297
298
299
 
# File 'lib/purecloudclient_v2a/models/dialer_action.rb', line 297

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



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/purecloudclient_v2a/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