Class: PureCloud::IntradayResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IntradayResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 93

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

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

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

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

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

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

  
end

Instance Attribute Details

#end_date ⇒ Object

The end of the date range for which this data applies. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def end_date
  @end_date
end

#interval_length_minutes ⇒ Object

The aggregation period in minutes, which determines the interval duration of the returned data



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

def interval_length_minutes
  @interval_length_minutes
end

#intraday_data_groupings ⇒ Object

Intraday data grouped by a single media type and set of queue IDs



43
44
45
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 43

def intraday_data_groupings
  @intraday_data_groupings
end

#metrics ⇒ Object

The metrics to which this data corresponds



34
35
36
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 34

def metrics
  @metrics
end

#no_data_reason ⇒ Object

If not null, the reason there was no data for the request



37
38
39
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 37

def no_data_reason
  @no_data_reason
end

#number_of_intervals ⇒ Object

The total number of time intervals represented by this data



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

def number_of_intervals
  @number_of_intervals
end

#queue_ids ⇒ Object

The IDs of the queues this data corresponds to



40
41
42
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 40

def queue_ids
  @queue_ids
end

#start_date ⇒ Object

The start of the date range for which this data applies. This is also the start reference point for the intervals represented in the various arrays. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def start_date
  @start_date
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'start_date' => :'startDate',
    
    :'end_date' => :'endDate',
    
    :'interval_length_minutes' => :'intervalLengthMinutes',
    
    :'number_of_intervals' => :'numberOfIntervals',
    
    :'metrics' => :'metrics',
    
    :'no_data_reason' => :'noDataReason',
    
    :'queue_ids' => :'queueIds',
    
    :'intraday_data_groupings' => :'intradayDataGroupings'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'start_date' => :'DateTime',
    
    :'end_date' => :'DateTime',
    
    :'interval_length_minutes' => :'Integer',
    
    :'number_of_intervals' => :'Integer',
    
    :'metrics' => :'Array<IntradayMetric>',
    
    :'no_data_reason' => :'String',
    
    :'queue_ids' => :'Array<String>',
    
    :'intraday_data_groupings' => :'Array<IntradayDataGroup>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      interval_length_minutes == o.interval_length_minutes &&
      number_of_intervals == o.number_of_intervals &&
      metrics == o.metrics &&
      no_data_reason == o.no_data_reason &&
      queue_ids == o.queue_ids &&
      intraday_data_groupings == o.intraday_data_groupings
end

#_deserialize(type, value) ⇒ Object 



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
361
362
363
364
365
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 329

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 389

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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 310

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


299
300
301
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 299

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



305
306
307
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 305

def hash
  [start_date, end_date, interval_length_minutes, number_of_intervals, metrics, no_data_reason, queue_ids, intraday_data_groupings].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



182
183
184
185
186
187
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 182

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



372
373
374
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 372

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



377
378
379
380
381
382
383
384
385
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 377

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 



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

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



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
226
227
228
229
230
 
# File 'lib/purecloudclient_v2a/models/intraday_response.rb', line 191

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["NoWeekData", "NoPublishedSchedule", "NoSourceForecast"]
  if @no_data_reason && !allowed_values.include?(@no_data_reason)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
end