Class: PureCloud::CoachingAppointmentResponse

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

Overview

Coaching appointment response

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CoachingAppointmentResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
305
306
307
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 150

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  
end

Instance Attribute Details

#attendees ⇒ Object

The list of attendees attending the coaching



44
45
46
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 44

def attendees
  @attendees
end

#conversations ⇒ Object

The list of conversations associated with coaching appointment.



59
60
61
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 59

def conversations
  @conversations
end

#created_by ⇒ Object

The user who created the coaching appointment



47
48
49
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 47

def created_by
  @created_by
end

#date_created ⇒ Object

The date/time the coaching appointment was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



50
51
52
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 50

def date_created
  @date_created
end

#date_modified ⇒ Object

The date/time the coaching appointment was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



56
57
58
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 56

def date_modified
  @date_modified
end

#date_start ⇒ Object

The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_start
  @date_start
end

#description ⇒ Object

The description of coaching appointment



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

def description
  @description
end

#documents ⇒ Object

The list of documents associated with coaching appointment.



62
63
64
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 62

def documents
  @documents
end

#facilitator ⇒ Object

The facilitator of coaching appointment



41
42
43
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 41

def facilitator
  @facilitator
end

#id ⇒ Object

The globally unique identifier for the object.



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

def id
  @id
end

#is_overdue ⇒ Object

Whether the appointment is overdue.



65
66
67
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 65

def is_overdue
  @is_overdue
end

#length_in_minutes ⇒ Object

The duration of coaching appointment in minutes



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

def length_in_minutes
  @length_in_minutes
end

#modified_by ⇒ Object

The last user to modify the coaching appointment



53
54
55
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 53

def modified_by
  @modified_by
end

#name ⇒ Object

The name of coaching appointment



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

def name
  @name
end

#self_uri ⇒ Object

The URI for this object



68
69
70
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 68

def self_uri
  @self_uri
end

#status ⇒ Object

The status of coaching appointment



38
39
40
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 38

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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
107
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 71

def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'date_start' => :'dateStart',
    
    :'length_in_minutes' => :'lengthInMinutes',
    
    :'status' => :'status',
    
    :'facilitator' => :'facilitator',
    
    :'attendees' => :'attendees',
    
    :'created_by' => :'createdBy',
    
    :'date_created' => :'dateCreated',
    
    :'modified_by' => :'modifiedBy',
    
    :'date_modified' => :'dateModified',
    
    :'conversations' => :'conversations',
    
    :'documents' => :'documents',
    
    :'is_overdue' => :'isOverdue',
    
    :'self_uri' => :'selfUri'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'id' => :'String',
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'date_start' => :'DateTime',
    
    :'length_in_minutes' => :'Integer',
    
    :'status' => :'String',
    
    :'facilitator' => :'UserReference',
    
    :'attendees' => :'Array<UserReference>',
    
    :'created_by' => :'UserReference',
    
    :'date_created' => :'DateTime',
    
    :'modified_by' => :'UserReference',
    
    :'date_modified' => :'DateTime',
    
    :'conversations' => :'Array<ConversationReference>',
    
    :'documents' => :'Array<DocumentReference>',
    
    :'is_overdue' => :'BOOLEAN',
    
    :'self_uri' => :'String'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 485

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      description == o.description &&
      date_start == o.date_start &&
      length_in_minutes == o.length_in_minutes &&
      status == o.status &&
      facilitator == o.facilitator &&
      attendees == o.attendees &&
      created_by == o.created_by &&
      date_created == o.date_created &&
      modified_by == o.modified_by &&
      date_modified == o.date_modified &&
      conversations == o.conversations &&
      documents == o.documents &&
      is_overdue == o.is_overdue &&
      self_uri == o.self_uri
end

#_deserialize(type, value) ⇒ Object 



538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 538

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



598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 598

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



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 519

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


508
509
510
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 508

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



514
515
516
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 514

def hash
  [id, name, description, date_start, length_in_minutes, status, facilitator, attendees, created_by, date_created, modified_by, date_modified, conversations, documents, is_overdue, 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



311
312
313
314
315
316
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 311

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



581
582
583
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 581

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



586
587
588
589
590
591
592
593
594
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 586

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 



576
577
578
 
# File 'lib/purecloudplatformclientv2/models/coaching_appointment_response.rb', line 576

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



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

def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  allowed_values = ["Scheduled", "InProgress", "Completed", "InvalidSchedule"]
  if @status && !allowed_values.include?(@status)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end