Class: CMV4APIClient::Organisation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Organisation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CMV4APIClient::Organisation` 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::Organisation`. 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?(:'abn')
    self.abn = attributes[:'abn']
  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?(:'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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#abn ⇒ Object

Returns the value of attribute abn.



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

def abn
  @abn
end

#created ⇒ Object

Returns the value of attribute created.



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

def created
  @created
end

#created_by ⇒ Object

Returns the value of attribute created_by.



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

def created_by
  @created_by
end

#database_id ⇒ Object

Returns the value of attribute database_id.



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

def database_id
  @database_id
end

#deleted ⇒ Object

Returns the value of attribute deleted.



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

def deleted
  @deleted
end

#descriptor ⇒ Object

Returns the value of attribute descriptor.



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

def descriptor
  @descriptor
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#modified ⇒ Object

Returns the value of attribute modified.



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

def modified
  @modified
end

#modified_by ⇒ Object

Returns the value of attribute modified_by.



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

def modified_by
  @modified_by
end

#modified_end_time ⇒ Object

Returns the value of attribute modified_end_time.



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

def modified_end_time
  @modified_end_time
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#phonenumber ⇒ Object

Returns the value of attribute phonenumber.



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

def phonenumber
  @phonenumber
end

#physicallocation ⇒ Object

Returns the value of attribute physicallocation.



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

def physicallocation
  @physicallocation
end

#physicallocation_address ⇒ Object

Returns the value of attribute physicallocation_address.



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

def physicallocation_address
  @physicallocation_address
end

#physicallocation_country ⇒ Object

Returns the value of attribute physicallocation_country.



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

def physicallocation_country
  @physicallocation_country
end

#physicallocation_location ⇒ Object

Returns the value of attribute physicallocation_location.



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

def physicallocation_location
  @physicallocation_location
end

#physicallocation_post_code ⇒ Object

Returns the value of attribute physicallocation_post_code.



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

def physicallocation_post_code
  @physicallocation_post_code
end

#physicallocation_state ⇒ Object

Returns the value of attribute physicallocation_state.



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

def physicallocation_state
  @physicallocation_state
end

#physicallocation_suburb ⇒ Object

Returns the value of attribute physicallocation_suburb.



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

def physicallocation_suburb
  @physicallocation_suburb
end

#postaladdress ⇒ Object

Returns the value of attribute postaladdress.



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

def postaladdress
  @postaladdress
end

#postaladdress_address ⇒ Object

Returns the value of attribute postaladdress_address.



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

def postaladdress_address
  @postaladdress_address
end

#postaladdress_country ⇒ Object

Returns the value of attribute postaladdress_country.



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

def postaladdress_country
  @postaladdress_country
end

#postaladdress_location ⇒ Object

Returns the value of attribute postaladdress_location.



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

def postaladdress_location
  @postaladdress_location
end

#postaladdress_post_code ⇒ Object

Returns the value of attribute postaladdress_post_code.



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

def postaladdress_post_code
  @postaladdress_post_code
end

#postaladdress_state ⇒ Object

Returns the value of attribute postaladdress_state.



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

def postaladdress_state
  @postaladdress_state
end

#postaladdress_suburb ⇒ Object

Returns the value of attribute postaladdress_suburb.



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

def postaladdress_suburb
  @postaladdress_suburb
end

#related_projects ⇒ Object

Returns the value of attribute related_projects.



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

def related_projects
  @related_projects
end

#visibility ⇒ Object

Returns the value of attribute visibility.



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

def visibility
  @visibility
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'abn' => :'abn',
    :'created' => :'created',
    :'created_by' => :'createdBy',
    :'database_id' => :'databaseId',
    :'deleted' => :'deleted',
    :'descriptor' => :'descriptor',
    :'modified' => :'modified',
    :'modified_by' => :'modifiedBy',
    :'modified_end_time' => :'modifiedEndTime',
    :'name' => :'name',
    :'phonenumber' => :'phonenumber',
    :'physicallocation' => :'physicallocation',
    :'physicallocation_address' => :'physicallocation.address',
    :'physicallocation_country' => :'physicallocation.country',
    :'physicallocation_location' => :'physicallocation.location',
    :'physicallocation_post_code' => :'physicallocation.postCode',
    :'physicallocation_state' => :'physicallocation.state',
    :'physicallocation_suburb' => :'physicallocation.suburb',
    :'postaladdress' => :'postaladdress',
    :'postaladdress_address' => :'postaladdress.address',
    :'postaladdress_country' => :'postaladdress.country',
    :'postaladdress_location' => :'postaladdress.location',
    :'postaladdress_post_code' => :'postaladdress.postCode',
    :'postaladdress_state' => :'postaladdress.state',
    :'postaladdress_suburb' => :'postaladdress.suburb',
    :'related_projects' => :'relatedProjects',
    :'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



360
361
362
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 360

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 142

def self.openapi_nullable
  Set.new([
    :'abn',
    :'created_by',
    :'descriptor',
    :'modified_by',
    :'name',
    :'physicallocation',
    :'physicallocation_address',
    :'physicallocation_country',
    :'physicallocation_location',
    :'physicallocation_post_code',
    :'physicallocation_state',
    :'physicallocation_suburb',
    :'postaladdress',
    :'postaladdress_address',
    :'postaladdress_country',
    :'postaladdress_location',
    :'postaladdress_post_code',
    :'postaladdress_state',
    :'postaladdress_suburb',
    :'related_projects',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'id' => :'Integer',
    :'abn' => :'String',
    :'created' => :'DateTime',
    :'created_by' => :'IdentityModel',
    :'database_id' => :'String',
    :'deleted' => :'Boolean',
    :'descriptor' => :'String',
    :'modified' => :'DateTime',
    :'modified_by' => :'IdentityModel',
    :'modified_end_time' => :'DateTime',
    :'name' => :'String',
    :'phonenumber' => :'Integer',
    :'physicallocation' => :'AddressModel',
    :'physicallocation_address' => :'String',
    :'physicallocation_country' => :'String',
    :'physicallocation_location' => :'String',
    :'physicallocation_post_code' => :'String',
    :'physicallocation_state' => :'String',
    :'physicallocation_suburb' => :'String',
    :'postaladdress' => :'AddressModel',
    :'postaladdress_address' => :'String',
    :'postaladdress_country' => :'String',
    :'postaladdress_location' => :'String',
    :'postaladdress_post_code' => :'String',
    :'postaladdress_state' => :'String',
    :'postaladdress_suburb' => :'String',
    :'related_projects' => :'Array<RelatedValue>',
    :'visibility' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
337
338
339
340
341
342
343
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 312

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      abn == o.abn &&
      created == o.created &&
      created_by == o.created_by &&
      database_id == o.database_id &&
      deleted == o.deleted &&
      descriptor == o.descriptor &&
      modified == o.modified &&
      modified_by == o.modified_by &&
      modified_end_time == o.modified_end_time &&
      name == o.name &&
      phonenumber == o.phonenumber &&
      physicallocation == o.physicallocation &&
      physicallocation_address == o.physicallocation_address &&
      physicallocation_country == o.physicallocation_country &&
      physicallocation_location == o.physicallocation_location &&
      physicallocation_post_code == o.physicallocation_post_code &&
      physicallocation_state == o.physicallocation_state &&
      physicallocation_suburb == o.physicallocation_suburb &&
      postaladdress == o.postaladdress &&
      postaladdress_address == o.postaladdress_address &&
      postaladdress_country == o.postaladdress_country &&
      postaladdress_location == o.postaladdress_location &&
      postaladdress_post_code == o.postaladdress_post_code &&
      postaladdress_state == o.postaladdress_state &&
      postaladdress_suburb == o.postaladdress_suburb &&
      related_projects == o.related_projects &&
      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



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

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



457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 457

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



367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 367

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


347
348
349
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 353

def hash
  [id, abn, created, created_by, database_id, deleted, descriptor, modified, modified_by, modified_end_time, name, phonenumber, physicallocation, physicallocation_address, physicallocation_country, physicallocation_location, physicallocation_post_code, physicallocation_state, physicallocation_suburb, postaladdress, postaladdress_address, postaladdress_country, postaladdress_location, postaladdress_post_code, postaladdress_state, postaladdress_suburb, related_projects, 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



299
300
301
302
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 299

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



433
434
435
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 433

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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 439

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



427
428
429
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 427

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



306
307
308
 
# File 'lib/cmv4-openapi-client/models/organisation.rb', line 306

def valid?
  true
end