Class: PureCloud::TimeOffRequestResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimeOffRequestResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 163

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'modifiedDate')
    
    
    self.modified_date = attributes[:'modifiedDate']
    
  
  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

#activity_code_id ⇒ Object

The ID of the activity code associated with this time off request. Activity code must be of the TimeOff category



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

def activity_code_id
  @activity_code_id
end

#daily_duration_minutes ⇒ Object

The daily duration of this time off request in minutes



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

def daily_duration_minutes
  @daily_duration_minutes
end

#full_day_management_unit_dates ⇒ Object

A set of dates in yyyy-MM-dd format. Should be interpreted in the management unit’s configured time zone. Will be not empty if isFullDayRequest == true



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

def full_day_management_unit_dates
  @full_day_management_unit_dates
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#is_full_day_request ⇒ Object

Whether this is a full day request (false means partial day)



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

def is_full_day_request
  @is_full_day_request
end

#marked_as_read ⇒ Object

Whether this request has been marked as read by the agent



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

def marked_as_read
  @marked_as_read
end

#metadata ⇒ Object

The version metadata of the time off request



70
71
72
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 70

def metadata
  @metadata
end

#modified_by ⇒ Object

The user who last modified this TimeOffRequestResponse



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

def modified_by
  @modified_by
end

#modified_date ⇒ Object

The timestamp when this request was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def modified_date
  @modified_date
end

#notes ⇒ Object

Notes about the time off request



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

def notes
  @notes
end

#partial_day_start_date_times ⇒ Object

A set of start date-times in ISO-8601 format for partial day requests. Will be not empty if isFullDayRequest == false



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

def partial_day_start_date_times
  @partial_day_start_date_times
end

#reviewed_by ⇒ Object

The user who reviewed this time off request



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

def reviewed_by
  @reviewed_by
end

#reviewed_date ⇒ Object

The timestamp when this request was reviewed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def reviewed_date
  @reviewed_date
end

#self_uri ⇒ Object

The URI for this object



73
74
75
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 73

def self_uri
  @self_uri
end

#status ⇒ Object

The status of this time off request



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

def status
  @status
end

#submitted_by ⇒ Object

The user who submitted this time off request



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

def submitted_by
  @submitted_by
end

#submitted_date ⇒ Object

The timestamp when this request was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def submitted_date
  @submitted_date
end

#user ⇒ Object

The user associated with this time off request



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

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'user' => :'user',
    
    :'is_full_day_request' => :'isFullDayRequest',
    
    :'marked_as_read' => :'markedAsRead',
    
    :'activity_code_id' => :'activityCodeId',
    
    :'status' => :'status',
    
    :'partial_day_start_date_times' => :'partialDayStartDateTimes',
    
    :'full_day_management_unit_dates' => :'fullDayManagementUnitDates',
    
    :'daily_duration_minutes' => :'dailyDurationMinutes',
    
    :'notes' => :'notes',
    
    :'submitted_by' => :'submittedBy',
    
    :'submitted_date' => :'submittedDate',
    
    :'reviewed_by' => :'reviewedBy',
    
    :'reviewed_date' => :'reviewedDate',
    
    :'modified_by' => :'modifiedBy',
    
    :'modified_date' => :'modifiedDate',
    
    :'metadata' => :'metadata',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'user' => :'UserReference',
    
    :'is_full_day_request' => :'BOOLEAN',
    
    :'marked_as_read' => :'BOOLEAN',
    
    :'activity_code_id' => :'String',
    
    :'status' => :'String',
    
    :'partial_day_start_date_times' => :'Array<DateTime>',
    
    :'full_day_management_unit_dates' => :'Array<String>',
    
    :'daily_duration_minutes' => :'Integer',
    
    :'notes' => :'String',
    
    :'submitted_by' => :'UserReference',
    
    :'submitted_date' => :'DateTime',
    
    :'reviewed_by' => :'UserReference',
    
    :'reviewed_date' => :'DateTime',
    
    :'modified_by' => :'UserReference',
    
    :'modified_date' => :'DateTime',
    
    :'metadata' => :'WfmVersionedEntityMetadata',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 532

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user == o.user &&
      is_full_day_request == o.is_full_day_request &&
      marked_as_read == o.marked_as_read &&
      activity_code_id == o.activity_code_id &&
      status == o.status &&
      partial_day_start_date_times == o.partial_day_start_date_times &&
      full_day_management_unit_dates == o.full_day_management_unit_dates &&
      daily_duration_minutes == o.daily_duration_minutes &&
      notes == o.notes &&
      submitted_by == o.submitted_by &&
      submitted_date == o.submitted_date &&
      reviewed_by == o.reviewed_by &&
      reviewed_date == o.reviewed_date &&
      modified_by == o.modified_by &&
      modified_date == o.modified_date &&
      metadata == o.metadata &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



587
588
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
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 587

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



647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 647

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



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

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


557
558
559
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 557

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



563
564
565
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 563

def hash
  [id, user, is_full_day_request, marked_as_read, activity_code_id, status, partial_day_start_date_times, full_day_management_unit_dates, daily_duration_minutes, notes, submitted_by, submitted_date, reviewed_by, reviewed_date, modified_by, modified_date, 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



340
341
342
343
344
345
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 340

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



630
631
632
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 630

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



635
636
637
638
639
640
641
642
643
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 635

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 



625
626
627
 
# File 'lib/purecloudplatformclientv2/models/time_off_request_response.rb', line 625

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["PENDING", "APPROVED", "DENIED", "CANCELED"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end