Class: PureCloud::ReportingExportJobRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportingExportJobRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 149

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#exclude_empty_rows ⇒ Object

Excludes empty rows from the exports



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 55

def exclude_empty_rows
  @exclude_empty_rows
end

#export_format ⇒ Object

The requested format of the exported data



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

def export_format
  @export_format
end

#filter ⇒ Object

Filters to apply to create the view



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

def filter
  @filter
end

#has_custom_participant_attributes ⇒ Object

Indicates if custom participant attributes will be exported



64
65
66
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 64

def has_custom_participant_attributes
  @has_custom_participant_attributes
end

#has_format_durations ⇒ Object

Indicates if durations are formatted in hh:mm:ss format instead of ms



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

def has_format_durations
  @has_format_durations
end

#has_split_by_media ⇒ Object

Indicates if media type will be split in aggregate detail exports



58
59
60
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 58

def has_split_by_media
  @has_split_by_media
end

#has_split_filters ⇒ Object

Indicates if filters will be split in aggregate detail exports



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 52

def has_split_filters
  @has_split_filters
end

#interval ⇒ Object

The time period used to limit the the exported data. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss



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

def interval
  @interval
end

#locale ⇒ Object

The locale use for localization of the exported data, i.e. en-us, es-mx



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

def locale
  @locale
end

#name ⇒ Object

The user supplied name of the export request



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 22

def name
  @name
end

#period ⇒ Object

The Period of the request in which to break down the intervals. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H



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

def period
  @period
end

#read ⇒ Object

Indicates if the request has been marked as read



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

def read
  @read
end

#recipient_emails ⇒ Object

The list of email recipients for the exports



67
68
69
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 67

def recipient_emails
  @recipient_emails
end

#selected_columns ⇒ Object

The list of ordered selected columns from the export view by the user



61
62
63
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 61

def selected_columns
  @selected_columns
end

#time_zone ⇒ Object

The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London



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

def time_zone
  @time_zone
end

#view_type ⇒ Object

The type of view export job to be created



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

def view_type
  @view_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'time_zone' => :'timeZone',
    
    :'export_format' => :'exportFormat',
    
    :'interval' => :'interval',
    
    :'period' => :'period',
    
    :'view_type' => :'viewType',
    
    :'filter' => :'filter',
    
    :'read' => :'read',
    
    :'locale' => :'locale',
    
    :'has_format_durations' => :'hasFormatDurations',
    
    :'has_split_filters' => :'hasSplitFilters',
    
    :'exclude_empty_rows' => :'excludeEmptyRows',
    
    :'has_split_by_media' => :'hasSplitByMedia',
    
    :'selected_columns' => :'selectedColumns',
    
    :'has_custom_participant_attributes' => :'hasCustomParticipantAttributes',
    
    :'recipient_emails' => :'recipientEmails'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'time_zone' => :'String',
    
    :'export_format' => :'String',
    
    :'interval' => :'String',
    
    :'period' => :'String',
    
    :'view_type' => :'String',
    
    :'filter' => :'ViewFilter',
    
    :'read' => :'BOOLEAN',
    
    :'locale' => :'String',
    
    :'has_format_durations' => :'BOOLEAN',
    
    :'has_split_filters' => :'BOOLEAN',
    
    :'exclude_empty_rows' => :'BOOLEAN',
    
    :'has_split_by_media' => :'BOOLEAN',
    
    :'selected_columns' => :'Array<SelectedColumns>',
    
    :'has_custom_participant_attributes' => :'BOOLEAN',
    
    :'recipient_emails' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 536

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      time_zone == o.time_zone &&
      export_format == o.export_format &&
      interval == o.interval &&
      period == o.period &&
      view_type == o.view_type &&
      filter == o.filter &&
      read == o.read &&
      locale == o.locale &&
      has_format_durations == o.has_format_durations &&
      has_split_filters == o.has_split_filters &&
      exclude_empty_rows == o.exclude_empty_rows &&
      has_split_by_media == o.has_split_by_media &&
      selected_columns == o.selected_columns &&
      has_custom_participant_attributes == o.has_custom_participant_attributes &&
      recipient_emails == o.recipient_emails
end

#_deserialize(type, value) ⇒ Object 



589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 589

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



649
650
651
652
653
654
655
656
657
658
659
660
661
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 649

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



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 570

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


559
560
561
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 559

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



565
566
567
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 565

def hash
  [name, time_zone, export_format, interval, period, view_type, filter, read, locale, has_format_durations, has_split_filters, exclude_empty_rows, has_split_by_media, selected_columns, has_custom_participant_attributes, recipient_emails].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



308
309
310
311
312
313
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 308

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



632
633
634
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 632

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



637
638
639
640
641
642
643
644
645
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 637

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 



627
628
629
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 627

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



317
318
319
320
321
322
323
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
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
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
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/purecloudplatformclientv2/models/reporting_export_job_request.rb', line 317

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

  
  
  
  
  
  if @time_zone.nil?
    return false
  end

  
  
  
  
  
  if @export_format.nil?
    return false
  end

  
  
  allowed_values = ["CSV", "PDF"]
  if @export_format && !allowed_values.include?(@export_format)
    return false
  end
  
  
  
  
  if @interval.nil?
    return false
  end

  
  
  
  
  
  if @period.nil?
    return false
  end

  
  
  
  
  
  if @view_type.nil?
    return false
  end

  
  
  allowed_values = ["QUEUE_PERFORMANCE_SUMMARY_VIEW", "QUEUE_PERFORMANCE_DETAIL_VIEW", "INTERACTION_SEARCH_VIEW", "AGENT_PERFORMANCE_SUMMARY_VIEW", "AGENT_PERFORMANCE_DETAIL_VIEW", "AGENT_STATUS_SUMMARY_VIEW", "AGENT_STATUS_DETAIL_VIEW", "AGENT_EVALUATION_SUMMARY_VIEW", "AGENT_EVALUATION_DETAIL_VIEW", "AGENT_QUEUE_DETAIL_VIEW", "AGENT_INTERACTION_DETAIL_VIEW", "ABANDON_INSIGHTS_VIEW", "SKILLS_PERFORMANCE_VIEW", "SURVEY_FORM_PERFORMANCE_SUMMARY_VIEW", "SURVEY_FORM_PERFORMANCE_DETAIL_VIEW", "DNIS_PERFORMANCE_SUMMARY_VIEW", "DNIS_PERFORMANCE_DETAIL_VIEW", "WRAP_UP_PERFORMANCE_SUMMARY_VIEW", "AGENT_WRAP_UP_PERFORMANCE_DETAIL_VIEW", "QUEUE_ACTIVITY_SUMMARY_VIEW", "QUEUE_ACTIVITY_DETAIL_VIEW", "AGENT_QUEUE_ACTIVITY_SUMMARY_VIEW", "QUEUE_AGENT_DETAIL_VIEW", "QUEUE_INTERACTION_DETAIL_VIEW", "AGENT_SCHEDULE_DETAIL_VIEW", "IVR_PERFORMANCE_SUMMARY_VIEW", "IVR_PERFORMANCE_DETAIL_VIEW", "ANSWER_INSIGHTS_VIEW", "HANDLE_INSIGHTS_VIEW", "TALK_INSIGHTS_VIEW", "HOLD_INSIGHTS_VIEW", "ACW_INSIGHTS_VIEW", "WAIT_INSIGHTS_VIEW", "AGENT_WRAP_UP_PERFORMANCE_INTERVAL_DETAIL_VIEW", "FLOW_OUTCOME_SUMMARY_VIEW", "FLOW_OUTCOME_PERFORMANCE_DETAIL_VIEW", "FLOW_OUTCOME_PERFORMANCE_INTERVAL_DETAIL_VIEW", "FLOW_DESTINATION_SUMMARY_VIEW", "FLOW_DESTINATION_DETAIL_VIEW", "API_USAGE_VIEW"]
  if @view_type && !allowed_values.include?(@view_type)
    return false
  end
  
  
  
  
  if @filter.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @locale.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end