Class: PureCloud::TimeOffRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/models/time_off_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimeOffRequest

Returns a new instance of TimeOffRequest.



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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/purecloud/models/time_off_request.rb', line 142

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'isFullDayRequest']
    self.is_full_day_request = attributes[:'isFullDayRequest']
  end
  
  if attributes[:'markedAsRead']
    self.marked_as_read = attributes[:'markedAsRead']
  end
  
  if attributes[:'activityCodeId']
    self.activity_code_id = attributes[:'activityCodeId']
  end
  
  if attributes[:'status']
    self.status = attributes[:'status']
  end
  
  if attributes[:'partialDayStartDateTimes']
    if (value = attributes[:'partialDayStartDateTimes']).is_a?(Array)
      self.partial_day_start_date_times = value
    end
  end
  
  if attributes[:'dailyDurationMinutes']
    self.daily_duration_minutes = attributes[:'dailyDurationMinutes']
  end
  
  if attributes[:'notes']
    self.notes = attributes[:'notes']
  end
  
  if attributes[:'submittedBy']
    self.submitted_by = attributes[:'submittedBy']
  end
  
  if attributes[:'submittedDate']
    self.submitted_date = attributes[:'submittedDate']
  end
  
  if attributes[:'reviewedBy']
    self.reviewed_by = attributes[:'reviewedBy']
  end
  
  if attributes[:'reviewedDate']
    self.reviewed_date = attributes[:'reviewedDate']
  end
  
  if attributes[:'modifiedBy']
    self.modified_by = attributes[:'modifiedBy']
  end
  
  if attributes[:'modifiedDate']
    self.modified_date = attributes[:'modifiedDate']
  end
  
  if attributes[:'selfUri']
    self.self_uri = attributes[:'selfUri']
  end
  
  if attributes[:'fullDayManagementUnitDates']
    if (value = attributes[:'fullDayManagementUnitDates']).is_a?(Array)
      self.full_day_management_unit_dates = value
    end
  end
  
end

Instance Attribute Details

#activity_code_id ⇒ Object

The ID of the activity code associated with this TimeOffRequest



36
37
38
 
# File 'lib/purecloud/models/time_off_request.rb', line 36

def activity_code_id
  @activity_code_id
end

#daily_duration_minutes ⇒ Object

The daily duration of this TimeOffRequest in minutes



45
46
47
 
# File 'lib/purecloud/models/time_off_request.rb', line 45

def daily_duration_minutes
  @daily_duration_minutes
end

#full_day_management_unit_dates ⇒ Object

ISO-8601 date only with no timezones. Should be interpreted in the Management Unit’s configured time zone. Required if isFullDayRequest == true



72
73
74
 
# File 'lib/purecloud/models/time_off_request.rb', line 72

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/purecloud/models/time_off_request.rb', line 22

def id
  @id
end

#is_full_day_request ⇒ Object

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



30
31
32
 
# File 'lib/purecloud/models/time_off_request.rb', line 30

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



33
34
35
 
# File 'lib/purecloud/models/time_off_request.rb', line 33

def marked_as_read
  @marked_as_read
end

#modified_by ⇒ Object

The user who last modified this TimeOffRequest



63
64
65
 
# File 'lib/purecloud/models/time_off_request.rb', line 63

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



66
67
68
 
# File 'lib/purecloud/models/time_off_request.rb', line 66

def modified_date
  @modified_date
end

#name ⇒ Object

Returns the value of attribute name.



24
25
26
 
# File 'lib/purecloud/models/time_off_request.rb', line 24

def name
  @name
end

#notes ⇒ Object

The notes as input by the one who entered the TimeOffRequest



48
49
50
 
# File 'lib/purecloud/models/time_off_request.rb', line 48

def notes
  @notes
end

#partial_day_start_date_times ⇒ Object

The start date-times for partial day requests. Required if isFullDayRequest == false



42
43
44
 
# File 'lib/purecloud/models/time_off_request.rb', line 42

def partial_day_start_date_times
  @partial_day_start_date_times
end

#reviewed_by ⇒ Object

The user who reviewed this TimeOffRequest



57
58
59
 
# File 'lib/purecloud/models/time_off_request.rb', line 57

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



60
61
62
 
# File 'lib/purecloud/models/time_off_request.rb', line 60

def reviewed_date
  @reviewed_date
end

#self_uri ⇒ Object

The URI for this object



69
70
71
 
# File 'lib/purecloud/models/time_off_request.rb', line 69

def self_uri
  @self_uri
end

#status ⇒ Object

The administrative status of this TimeOffRequest



39
40
41
 
# File 'lib/purecloud/models/time_off_request.rb', line 39

def status
  @status
end

#submitted_by ⇒ Object

The user who submitted this TimeOffRequest



51
52
53
 
# File 'lib/purecloud/models/time_off_request.rb', line 51

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



54
55
56
 
# File 'lib/purecloud/models/time_off_request.rb', line 54

def submitted_date
  @submitted_date
end

#user ⇒ Object

The user associated with this TimeOffRequest



27
28
29
 
# File 'lib/purecloud/models/time_off_request.rb', line 27

def user
  @user
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/purecloud/models/time_off_request.rb', line 75

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

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/purecloud/models/time_off_request.rb', line 118

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

Instance Method Details

#==(o) ⇒ Object

Check equality by comparing each attribute.



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/purecloud/models/time_off_request.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      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 &&
      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 &&
      self_uri == o.self_uri &&
      full_day_management_unit_dates == o.full_day_management_unit_dates
end

#_deserialize(type, value) ⇒ Object 



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
 
# File 'lib/purecloud/models/time_off_request.rb', line 290

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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/purecloud/models/time_off_request.rb', line 350

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/purecloud/models/time_off_request.rb', line 271

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

Returns:

  • (Boolean)

See Also:

  • `==` method


261
262
263
 
# File 'lib/purecloud/models/time_off_request.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Object

Calculate hash code according to all attributes.



266
267
268
 
# File 'lib/purecloud/models/time_off_request.rb', line 266

def hash
  [id, name, user, is_full_day_request, marked_as_read, activity_code_id, status, partial_day_start_date_times, daily_duration_minutes, notes, submitted_by, submitted_date, reviewed_by, reviewed_date, modified_by, modified_date, self_uri, full_day_management_unit_dates].hash
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



333
334
335
 
# File 'lib/purecloud/models/time_off_request.rb', line 333

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



338
339
340
341
342
343
344
345
346
 
# File 'lib/purecloud/models/time_off_request.rb', line 338

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 



328
329
330
 
# File 'lib/purecloud/models/time_off_request.rb', line 328

def to_s
  to_hash.to_s
end