Class: PureCloud::CreateCoachingAppointmentRequest

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

Overview

Create coaching appointment request

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateCoachingAppointmentRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
179
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 94

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

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

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

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

  
end

Instance Attribute Details

#attendee_ids ⇒ Object

IDs of attendees in the coaching appointment.



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

def attendee_ids
  @attendee_ids
end

#conversation_ids ⇒ Object

IDs of conversations associated with this coaching appointment.



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

def conversation_ids
  @conversation_ids
end

#date_start ⇒ Object

The date/time the coaching appointment starts. Times will be rounded down to the minute. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ



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

def date_start
  @date_start
end

#description ⇒ Object

The description of coaching appointment.



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

def description
  @description
end

#document_ids ⇒ Object

IDs of documents associated with this coaching appointment.



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

def document_ids
  @document_ids
end

#facilitator_id ⇒ Object

The facilitator ID of coaching appointment.



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

def facilitator_id
  @facilitator_id
end

#length_in_minutes ⇒ Object

The duration of coaching appointment in minutes.



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

def length_in_minutes
  @length_in_minutes
end

#name ⇒ Object

The name of coaching appointment.



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

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    
    :'name' => :'name',
    
    :'description' => :'description',
    
    :'date_start' => :'dateStart',
    
    :'length_in_minutes' => :'lengthInMinutes',
    
    :'facilitator_id' => :'facilitatorId',
    
    :'attendee_ids' => :'attendeeIds',
    
    :'conversation_ids' => :'conversationIds',
    
    :'document_ids' => :'documentIds'
    
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    
    :'name' => :'String',
    
    :'description' => :'String',
    
    :'date_start' => :'DateTime',
    
    :'length_in_minutes' => :'Integer',
    
    :'facilitator_id' => :'String',
    
    :'attendee_ids' => :'Array<String>',
    
    :'conversation_ids' => :'Array<String>',
    
    :'document_ids' => :'Array<String>'
    
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      description == o.description &&
      date_start == o.date_start &&
      length_in_minutes == o.length_in_minutes &&
      facilitator_id == o.facilitator_id &&
      attendee_ids == o.attendee_ids &&
      conversation_ids == o.conversation_ids &&
      document_ids == o.document_ids
end

#_deserialize(type, value) ⇒ Object 



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

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



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 411

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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 332

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


321
322
323
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 321

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



327
328
329
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 327

def hash
  [name, description, date_start, length_in_minutes, facilitator_id, attendee_ids, conversation_ids, document_ids].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



183
184
185
186
187
188
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 183

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



394
395
396
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 394

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



399
400
401
402
403
404
405
406
407
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 399

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 



389
390
391
 
# File 'lib/purecloudplatformclientv2/models/create_coaching_appointment_request.rb', line 389

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



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

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

  
  
  
  
  
  if @description.nil?
    return false
  end

  
  
  
  
  
  if @date_start.nil?
    return false
  end

  
  
  
  
  
  if @length_in_minutes.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  if @attendee_ids.nil?
    return false
  end

  
  
  
  
  
  if @conversation_ids.nil?
    return false
  end

  
  
  
  
  
  if @document_ids.nil?
    return false
  end

  
  
  
  
end