Class: PureCloud::ActivityCode

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

Overview

Activity code data

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActivityCode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 94

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?(:'name')
    
    
    self.name = attributes[:'name']
    
  
  end

  
  if attributes.has_key?(:'isActive')
    
    
    self.is_active = attributes[:'isActive']
    
  
  end

  
  if attributes.has_key?(:'isDefault')
    
    
    self.is_default = attributes[:'isDefault']
    
  
  end

  
  if attributes.has_key?(:'category')
    
    
    self.category = attributes[:'category']
    
  
  end

  
  if attributes.has_key?(:'lengthInMinutes')
    
    
    self.length_in_minutes = attributes[:'lengthInMinutes']
    
  
  end

  
  if attributes.has_key?(:'countsAsPaidTime')
    
    
    self.counts_as_paid_time = attributes[:'countsAsPaidTime']
    
  
  end

  
  if attributes.has_key?(:'countsAsWorkTime')
    
    
    self.counts_as_work_time = attributes[:'countsAsWorkTime']
    
  
  end

  
  if attributes.has_key?(:'isAgentTimeOffSelectable')
    
    
    self.is_agent_time_off_selectable = attributes[:'isAgentTimeOffSelectable']
    
  
  end

  
end

Instance Attribute Details

#category ⇒ Object

The activity code’s category



32
33
34
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 32

def category
  @category
end

#counts_as_paid_time ⇒ Object

Whether an agent is paid while performing this activity



38
39
40
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 38

def counts_as_paid_time
  @counts_as_paid_time
end

#counts_as_work_time ⇒ Object

Indicates whether or not the activity should be counted as work time



41
42
43
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 41

def counts_as_work_time
  @counts_as_work_time
end

#is_active ⇒ Object

Whether this activity code is active or only used for historical schedules



26
27
28
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 26

def is_active
  @is_active
end

#is_agent_time_off_selectable ⇒ Object

Whether an agent can select this activity code when creating or editing a time off request



44
45
46
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 44

def is_agent_time_off_selectable
  @is_agent_time_off_selectable
end

#is_default ⇒ Object

Whether this is a default activity code



29
30
31
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 29

def is_default
  @is_default
end

#length_in_minutes ⇒ Object

The default length of the activity in minutes



35
36
37
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 35

def length_in_minutes
  @length_in_minutes
end

#name ⇒ Object

The activity code’s name



23
24
25
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 23

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 47

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'is_active' => :'isActive',
    
    :'is_default' => :'isDefault',
    
    :'category' => :'category',
    
    :'length_in_minutes' => :'lengthInMinutes',
    
    :'counts_as_paid_time' => :'countsAsPaidTime',
    
    :'counts_as_work_time' => :'countsAsWorkTime',
    
    :'is_agent_time_off_selectable' => :'isAgentTimeOffSelectable'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 70

def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'is_active' => :'BOOLEAN',
    
    :'is_default' => :'BOOLEAN',
    
    :'category' => :'String',
    
    :'length_in_minutes' => :'Integer',
    
    :'counts_as_paid_time' => :'BOOLEAN',
    
    :'counts_as_work_time' => :'BOOLEAN',
    
    :'is_agent_time_off_selectable' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      is_active == o.is_active &&
      is_default == o.is_default &&
      category == o.category &&
      length_in_minutes == o.length_in_minutes &&
      counts_as_paid_time == o.counts_as_paid_time &&
      counts_as_work_time == o.counts_as_work_time &&
      is_agent_time_off_selectable == o.is_agent_time_off_selectable
end

#_deserialize(type, value) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 324

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 384

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 305

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


294
295
296
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 294

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



300
301
302
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 300

def hash
  [name, is_active, is_default, category, length_in_minutes, counts_as_paid_time, counts_as_work_time, is_agent_time_off_selectable].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



177
178
179
180
181
182
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 177

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))



367
368
369
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 367

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



372
373
374
375
376
377
378
379
380
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 372

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 



362
363
364
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 362

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/purecloudclient_v2a/models/activity_code.rb', line 186

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["OnQueueWork", "Break", "Meal", "Meeting", "OffQueueWork", "TimeOff", "Training", "Unavailable", "Unscheduled"]
  if @category && !allowed_values.include?(@category)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end