Class: PureCloud::WfmHistoricalAdherenceQuery

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

Overview

Query to request a historical adherence report from Workforce Management Service

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WfmHistoricalAdherenceQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 73

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

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

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

  
  if attributes.has_key?(:'userIds')
    
    if (value = attributes[:'userIds']).is_a?(Array)
      self.user_ids = value
    end
    
    
  
  end

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

  
end

Instance Attribute Details

#end_date ⇒ Object

End of the date range to query in ISO-8601 format. If it is not set, end date will be set to current time



26
27
28
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 26

def end_date
  @end_date
end

#include_exceptions ⇒ Object

Whether user exceptions should be returned as part of the results



35
36
37
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 35

def include_exceptions
  @include_exceptions
end

#start_date ⇒ Object

Beginning of the date range to query in ISO-8601 format



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

def start_date
  @start_date
end

#time_zone ⇒ Object

The time zone to use for returned results in olson format. If it is not set, the management unit time zone will be used to compute adherence



29
30
31
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 29

def time_zone
  @time_zone
end

#user_ids ⇒ Object

The userIds to report on. If null or not set, adherence will be computed for all the users in management unit



32
33
34
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 32

def user_ids
  @user_ids
end

Class Method Details

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 38

def self.attribute_map
  {
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'time_zone' => :'timeZone',
    
    :'user_ids' => :'userIds',
    
    :'include_exceptions' => :'includeExceptions'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 55

def self.swagger_types
  {
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime',
    
    :'time_zone' => :'String',
    
    :'user_ids' => :'Array<String>',
    
    :'include_exceptions' => :'BOOLEAN'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



197
198
199
200
201
202
203
204
205
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 197

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      time_zone == o.time_zone &&
      user_ids == o.user_ids &&
      include_exceptions == o.include_exceptions
end

#_deserialize(type, value) ⇒ Object 



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
275
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 239

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 299

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 220

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


209
210
211
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 209

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



215
216
217
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 215

def hash
  [start_date, end_date, time_zone, user_ids, include_exceptions].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



131
132
133
134
135
136
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 131

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



282
283
284
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 282

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



287
288
289
290
291
292
293
294
295
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 287

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 



277
278
279
 
# File 'lib/purecloudplatformclientv2/models/wfm_historical_adherence_query.rb', line 277

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



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

def valid?
  
  
  if @start_date.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end