Class: PureCloud::ManagementUnit

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/management_unit.rb

Overview

Management Unit object for Workforce Management

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementUnit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 107

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#date_modified ⇒ Object

The date and time at which this entity was last modified. Deprecated, use metadata field instead. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 40

def date_modified
  @date_modified
end

#id ⇒ Object

The globally unique identifier for the object.



23
24
25
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 23

def id
  @id
end

#metadata ⇒ Object

Version info metadata for this management unit



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 46

def metadata
  @metadata
end

#modified_by ⇒ Object

The user who last modified this entity. Deprecated, use metadata field instead



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 43

def modified_by
  @modified_by
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 25

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 49

def self_uri
  @self_uri
end

#settings ⇒ Object

The configuration settings for this management unit



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 34

def settings
  @settings
end

#start_day_of_week ⇒ Object

Start day of week for scheduling and forecasting purposes



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 28

def start_day_of_week
  @start_day_of_week
end

#time_zone ⇒ Object

The time zone for the management unit in standard Olson Format (See en.wikipedia.org/wiki/Tz_database)



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 31

def time_zone
  @time_zone
end

#version ⇒ Object

The version of the underlying entity. Deprecated, use metadata field instead



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 37

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 52

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'start_day_of_week' => :'startDayOfWeek',
    
    :'time_zone' => :'timeZone',
    
    :'settings' => :'settings',
    
    :'version' => :'version',
    
    :'date_modified' => :'dateModified',
    
    :'modified_by' => :'modifiedBy',
    
    :'metadata' => :'metadata',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 79

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'start_day_of_week' => :'String',
    
    :'time_zone' => :'String',
    
    :'settings' => :'ManagementUnitSettings',
    
    :'version' => :'Integer',
    
    :'date_modified' => :'DateTime',
    
    :'modified_by' => :'UserReference',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 338

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      start_day_of_week == o.start_day_of_week &&
      time_zone == o.time_zone &&
      settings == o.settings &&
      version == o.version &&
      date_modified == o.date_modified &&
      modified_by == o.modified_by &&
      metadata == o.metadata &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 385

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



445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 445

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 366

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


355
356
357
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 355

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



361
362
363
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 361

def hash
  [id, name, start_day_of_week, time_zone, settings, version, date_modified, modified_by, metadata, self_uri].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



208
209
210
211
212
213
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 208

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



428
429
430
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 428

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



433
434
435
436
437
438
439
440
441
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 433

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 



423
424
425
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 423

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
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
270
271
272
273
274
 
# File 'lib/purecloudplatformclientv2/models/management_unit.rb', line 217

def valid?
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
  if @start_day_of_week && !allowed_values.include?(@start_day_of_week)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  if @version.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  if @metadata.nil?
    return false
  end

  
  
  
  
  
  
  
  
end