Class: SygnaBridgeIvmsUtil::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/sygna-bridge-ivms-util/models/address.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Address

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 123

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_line ⇒ Object

Returns the value of attribute address_line.



45
46
47
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 45

def address_line
  @address_line
end

#address_type ⇒ Object

Returns the value of attribute address_type.



17
18
19
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 17

def address_type
  @address_type
end

#building_name ⇒ Object

Returns the value of attribute building_name.



27
28
29
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 27

def building_name
  @building_name
end

#building_number ⇒ Object

Returns the value of attribute building_number.



25
26
27
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 25

def building_number
  @building_number
end

#country ⇒ Object

Returns the value of attribute country.



47
48
49
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 47

def country
  @country
end

#country_sub_division ⇒ Object

Returns the value of attribute country_sub_division.



43
44
45
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 43

def country_sub_division
  @country_sub_division
end

#department ⇒ Object

Returns the value of attribute department.



19
20
21
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 19

def department
  @department
end

#district_name ⇒ Object

Returns the value of attribute district_name.



41
42
43
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 41

def district_name
  @district_name
end

#floor ⇒ Object

Returns the value of attribute floor.



29
30
31
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 29

def floor
  @floor
end

#post_box ⇒ Object

Returns the value of attribute post_box.



31
32
33
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 31

def post_box
  @post_box
end

#post_code ⇒ Object

Returns the value of attribute post_code.



35
36
37
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 35

def post_code
  @post_code
end

#room ⇒ Object

Returns the value of attribute room.



33
34
35
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 33

def room
  @room
end

#street_name ⇒ Object

Returns the value of attribute street_name.



23
24
25
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 23

def street_name
  @street_name
end

#sub_department ⇒ Object

Returns the value of attribute sub_department.



21
22
23
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 21

def sub_department
  @sub_department
end

#town_location_name ⇒ Object

Returns the value of attribute town_location_name.



39
40
41
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 39

def town_location_name
  @town_location_name
end

#town_name ⇒ Object

Returns the value of attribute town_name.



37
38
39
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 37

def town_name
  @town_name
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 72

def self.attribute_map
  {
    :'address_type' => :'address_type',
    :'department' => :'department',
    :'sub_department' => :'sub_department',
    :'street_name' => :'street_name',
    :'building_number' => :'building_number',
    :'building_name' => :'building_name',
    :'floor' => :'floor',
    :'post_box' => :'post_box',
    :'room' => :'room',
    :'post_code' => :'post_code',
    :'town_name' => :'town_name',
    :'town_location_name' => :'town_location_name',
    :'district_name' => :'district_name',
    :'country_sub_division' => :'country_sub_division',
    :'address_line' => :'address_line',
    :'country' => :'country'
  }
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



266
267
268
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 266

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 116

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 94

def self.openapi_types
  {
    :'address_type' => :'String',
    :'department' => :'String',
    :'sub_department' => :'String',
    :'street_name' => :'String',
    :'building_number' => :'String',
    :'building_name' => :'String',
    :'floor' => :'String',
    :'post_box' => :'String',
    :'room' => :'String',
    :'post_code' => :'String',
    :'town_name' => :'String',
    :'town_location_name' => :'String',
    :'district_name' => :'String',
    :'country_sub_division' => :'String',
    :'address_line' => :'Array<String>',
    :'country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      address_type == o.address_type &&
      department == o.department &&
      sub_department == o.sub_department &&
      street_name == o.street_name &&
      building_number == o.building_number &&
      building_name == o.building_name &&
      floor == o.floor &&
      post_box == o.post_box &&
      room == o.room &&
      post_code == o.post_code &&
      town_name == o.town_name &&
      town_location_name == o.town_location_name &&
      district_name == o.district_name &&
      country_sub_division == o.country_sub_division &&
      address_line == o.address_line &&
      country == o.country
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



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
327
328
329
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 294

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
    SygnaBridgeIvmsUtil.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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 363

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 273

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


253
254
255
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 253

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



259
260
261
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 259

def hash
  [address_type, department, sub_department, street_name, building_number, building_name, floor, post_box, room, post_code, town_name, town_location_name, district_name, country_sub_division, address_line, country].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



205
206
207
208
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 205

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



339
340
341
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 339

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 345

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



333
334
335
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 333

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



212
213
214
215
216
 
# File 'lib/sygna-bridge-ivms-util/models/address.rb', line 212

def valid?
  address_type_validator = EnumAttributeValidator.new('String', ["HOME", "BIZZ", "GEOG"])
  return false unless address_type_validator.valid?(@address_type)
  true
end