Class: CMV4APIClient::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/cmv4-openapi-client/models/event.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Event

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 178

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CMV4APIClient::Event` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `CMV4APIClient::Event`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.key?(:'address')
    self.address = attributes[:'address']
  end

  if attributes.key?(:'address_address')
    self.address_address = attributes[:'address_address']
  end

  if attributes.key?(:'address_country')
    self.address_country = attributes[:'address_country']
  end

  if attributes.key?(:'address_location')
    self.address_location = attributes[:'address_location']
  end

  if attributes.key?(:'address_post_code')
    self.address_post_code = attributes[:'address_post_code']
  end

  if attributes.key?(:'address_state')
    self.address_state = attributes[:'address_state']
  end

  if attributes.key?(:'address_suburb')
    self.address_suburb = attributes[:'address_suburb']
  end

  if attributes.key?(:'comments')
    self.comments = attributes[:'comments']
  end

  if attributes.key?(:'created')
    self.created = attributes[:'created']
  end

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

  if attributes.key?(:'database_id')
    self.database_id = attributes[:'database_id']
  end

  if attributes.key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.key?(:'descriptor')
    self.descriptor = attributes[:'descriptor']
  end

  if attributes.key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end

  if attributes.key?(:'event_type')
    self.event_type = attributes[:'event_type']
  end

  if attributes.key?(:'issues')
    self.issues = attributes[:'issues']
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  end

  if attributes.key?(:'modified')
    self.modified = attributes[:'modified']
  end

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

  if attributes.key?(:'modified_end_time')
    self.modified_end_time = attributes[:'modified_end_time']
  end

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

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

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

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

  if attributes.key?(:'sentimentevents')
    self.sentimentevents = attributes[:'sentimentevents']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'summary')
    self.summary = attributes[:'summary']
  end

  if attributes.key?(:'team_response')
    self.team_response = attributes[:'team_response']
  end

  if attributes.key?(:'visibility')
    self.visibility = attributes[:'visibility']
  end
end

Instance Attribute Details

#address ⇒ Object

Returns the value of attribute address.



19
20
21
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 19

def address
  @address
end

#address_address ⇒ Object

Returns the value of attribute address_address.



21
22
23
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 21

def address_address
  @address_address
end

#address_country ⇒ Object

Returns the value of attribute address_country.



23
24
25
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 23

def address_country
  @address_country
end

#address_location ⇒ Object

Returns the value of attribute address_location.



25
26
27
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 25

def address_location
  @address_location
end

#address_post_code ⇒ Object

Returns the value of attribute address_post_code.



27
28
29
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 27

def address_post_code
  @address_post_code
end

#address_state ⇒ Object

Returns the value of attribute address_state.



29
30
31
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 29

def address_state
  @address_state
end

#address_suburb ⇒ Object

Returns the value of attribute address_suburb.



31
32
33
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 31

def address_suburb
  @address_suburb
end

#comments ⇒ Object

Returns the value of attribute comments.



33
34
35
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 33

def comments
  @comments
end

#created ⇒ Object

Returns the value of attribute created.



35
36
37
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 35

def created
  @created
end

#created_by ⇒ Object

Returns the value of attribute created_by.



37
38
39
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 37

def created_by
  @created_by
end

#database_id ⇒ Object

Returns the value of attribute database_id.



39
40
41
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 39

def database_id
  @database_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



41
42
43
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 41

def deleted
  @deleted
end

#descriptor ⇒ Object

Returns the value of attribute descriptor.



43
44
45
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 43

def descriptor
  @descriptor
end

#end_date ⇒ Object

Returns the value of attribute end_date.



45
46
47
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 45

def end_date
  @end_date
end

#event_type ⇒ Object

Returns the value of attribute event_type.



47
48
49
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 47

def event_type
  @event_type
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 17

def id
  @id
end

#issues ⇒ Object

Returns the value of attribute issues.



49
50
51
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 49

def issues
  @issues
end

#location ⇒ Object

Returns the value of attribute location.



51
52
53
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 51

def location
  @location
end

#modified ⇒ Object

Returns the value of attribute modified.



53
54
55
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 53

def modified
  @modified
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



55
56
57
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 55

def modified_by
  @modified_by
end

#modified_end_time ⇒ Object

Returns the value of attribute modified_end_time.



57
58
59
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 57

def modified_end_time
  @modified_end_time
end

#related_projects ⇒ Object

Returns the value of attribute related_projects.



59
60
61
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 59

def related_projects
  @related_projects
end

#related_property ⇒ Object

Returns the value of attribute related_property.



61
62
63
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 61

def related_property
  @related_property
end

#related_stakeholder ⇒ Object

Returns the value of attribute related_stakeholder.



63
64
65
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 63

def related_stakeholder
  @related_stakeholder
end

#related_user ⇒ Object

Returns the value of attribute related_user.



65
66
67
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 65

def related_user
  @related_user
end

#sentimentevents ⇒ Object

Returns the value of attribute sentimentevents.



67
68
69
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 67

def sentimentevents
  @sentimentevents
end

#start_date ⇒ Object

Returns the value of attribute start_date.



69
70
71
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 69

def start_date
  @start_date
end

#summary ⇒ Object

Returns the value of attribute summary.



71
72
73
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 71

def summary
  @summary
end

#team_response ⇒ Object

Returns the value of attribute team_response.



73
74
75
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 73

def team_response
  @team_response
end

#visibility ⇒ Object

Returns the value of attribute visibility.



75
76
77
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 75

def visibility
  @visibility
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'address' => :'address',
    :'address_address' => :'address.address',
    :'address_country' => :'address.country',
    :'address_location' => :'address.location',
    :'address_post_code' => :'address.postCode',
    :'address_state' => :'address.state',
    :'address_suburb' => :'address.suburb',
    :'comments' => :'comments',
    :'created' => :'created',
    :'created_by' => :'createdBy',
    :'database_id' => :'databaseId',
    :'deleted' => :'deleted',
    :'descriptor' => :'descriptor',
    :'end_date' => :'endDate',
    :'event_type' => :'eventType',
    :'issues' => :'issues',
    :'location' => :'location',
    :'modified' => :'modified',
    :'modified_by' => :'modifiedBy',
    :'modified_end_time' => :'modifiedEndTime',
    :'related_projects' => :'relatedProjects',
    :'related_property' => :'relatedProperty',
    :'related_stakeholder' => :'relatedStakeholder',
    :'related_user' => :'relatedUser',
    :'sentimentevents' => :'sentimentevents',
    :'start_date' => :'startDate',
    :'summary' => :'summary',
    :'team_response' => :'teamResponse',
    :'visibility' => :'visibility'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



385
386
387
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 385

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 150

def self.openapi_nullable
  Set.new([
    :'address',
    :'address_address',
    :'address_country',
    :'address_location',
    :'address_post_code',
    :'address_state',
    :'address_suburb',
    :'comments',
    :'created_by',
    :'descriptor',
    :'event_type',
    :'issues',
    :'location',
    :'modified_by',
    :'related_projects',
    :'related_property',
    :'related_stakeholder',
    :'related_user',
    :'sentimentevents',
    :'summary',
    :'team_response',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 114

def self.openapi_types
  {
    :'id' => :'Integer',
    :'address' => :'AddressModel',
    :'address_address' => :'String',
    :'address_country' => :'String',
    :'address_location' => :'String',
    :'address_post_code' => :'String',
    :'address_state' => :'String',
    :'address_suburb' => :'String',
    :'comments' => :'String',
    :'created' => :'DateTime',
    :'created_by' => :'IdentityModel',
    :'database_id' => :'String',
    :'deleted' => :'Boolean',
    :'descriptor' => :'String',
    :'end_date' => :'DateTime',
    :'event_type' => :'ClassificationModel',
    :'issues' => :'ClassificationSetModel',
    :'location' => :'String',
    :'modified' => :'DateTime',
    :'modified_by' => :'IdentityModel',
    :'modified_end_time' => :'DateTime',
    :'related_projects' => :'Array<RelatedValue>',
    :'related_property' => :'Array<RelatedValue>',
    :'related_stakeholder' => :'Array<RelatedValue>',
    :'related_user' => :'Array<RelatedValue>',
    :'sentimentevents' => :'ClassificationModel',
    :'start_date' => :'DateTime',
    :'summary' => :'String',
    :'team_response' => :'String',
    :'visibility' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 335

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      address == o.address &&
      address_address == o.address_address &&
      address_country == o.address_country &&
      address_location == o.address_location &&
      address_post_code == o.address_post_code &&
      address_state == o.address_state &&
      address_suburb == o.address_suburb &&
      comments == o.comments &&
      created == o.created &&
      created_by == o.created_by &&
      database_id == o.database_id &&
      deleted == o.deleted &&
      descriptor == o.descriptor &&
      end_date == o.end_date &&
      event_type == o.event_type &&
      issues == o.issues &&
      location == o.location &&
      modified == o.modified &&
      modified_by == o.modified_by &&
      modified_end_time == o.modified_end_time &&
      related_projects == o.related_projects &&
      related_property == o.related_property &&
      related_stakeholder == o.related_stakeholder &&
      related_user == o.related_user &&
      sentimentevents == o.sentimentevents &&
      start_date == o.start_date &&
      summary == o.summary &&
      team_response == o.team_response &&
      visibility == o.visibility
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 415

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 =~ /\A(true|t|yes|y|1)\z/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
    CMV4APIClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 484

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 392

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      puts "Did not find anything for #{key} #{type}"
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


372
373
374
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 372

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



378
379
380
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 378

def hash
  [id, address, address_address, address_country, address_location, address_post_code, address_state, address_suburb, comments, created, created_by, database_id, deleted, descriptor, end_date, event_type, issues, location, modified, modified_by, modified_end_time, related_projects, related_property, related_stakeholder, related_user, sentimentevents, start_date, summary, team_response, visibility].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



322
323
324
325
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 322

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



460
461
462
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 460

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 466

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



454
455
456
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 454

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



329
330
331
 
# File 'lib/cmv4-openapi-client/models/event.rb', line 329

def valid?
  true
end