Class: TripletexApi::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/tripletex_api/models/address.rb

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



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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'lib/tripletex_api/models/address.rb', line 77

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#address_line1Object

Returns the value of attribute address_line1.



28
29
30
# File 'lib/tripletex_api/models/address.rb', line 28

def address_line1
  @address_line1
end

#address_line2Object

Returns the value of attribute address_line2.



30
31
32
# File 'lib/tripletex_api/models/address.rb', line 30

def address_line2
  @address_line2
end

#changesObject

Returns the value of attribute changes.



22
23
24
# File 'lib/tripletex_api/models/address.rb', line 22

def changes
  @changes
end

#cityObject

Returns the value of attribute city.



34
35
36
# File 'lib/tripletex_api/models/address.rb', line 34

def city
  @city
end

#countryObject

Returns the value of attribute country.



36
37
38
# File 'lib/tripletex_api/models/address.rb', line 36

def country
  @country
end

#employeeObject

Returns the value of attribute employee.



26
27
28
# File 'lib/tripletex_api/models/address.rb', line 26

def employee
  @employee
end

#idObject

Returns the value of attribute id.



18
19
20
# File 'lib/tripletex_api/models/address.rb', line 18

def id
  @id
end

#nameObject

Returns the value of attribute name.



38
39
40
# File 'lib/tripletex_api/models/address.rb', line 38

def name
  @name
end

#postal_codeObject

Returns the value of attribute postal_code.



32
33
34
# File 'lib/tripletex_api/models/address.rb', line 32

def postal_code
  @postal_code
end

#urlObject

Returns the value of attribute url.



24
25
26
# File 'lib/tripletex_api/models/address.rb', line 24

def url
  @url
end

#versionObject

Returns the value of attribute version.



20
21
22
# File 'lib/tripletex_api/models/address.rb', line 20

def version
  @version
end

Class Method Details

.attribute_mapObject

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



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/tripletex_api/models/address.rb', line 42

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'changes' => :'changes',
    :'url' => :'url',
    :'employee' => :'employee',
    :'address_line1' => :'addressLine1',
    :'address_line2' => :'addressLine2',
    :'postal_code' => :'postalCode',
    :'city' => :'city',
    :'country' => :'country',
    :'name' => :'name'
  }
end

.swagger_typesObject

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/tripletex_api/models/address.rb', line 59

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'changes' => :'Array<Change>',
    :'url' => :'String',
    :'employee' => :'Employee',
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'postal_code' => :'String',
    :'city' => :'String',
    :'country' => :'Country',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/tripletex_api/models/address.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      version == o.version &&
      changes == o.changes &&
      url == o.url &&
      employee == o.employee &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      postal_code == o.postal_code &&
      city == o.city &&
      country == o.country &&
      name == o.name
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



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
344
345
346
347
348
349
350
# File 'lib/tripletex_api/models/address.rb', line 314

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
    temp_model = TripletexApi.const_get(type).new
    temp_model.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



380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/tripletex_api/models/address.rb', line 380

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/tripletex_api/models/address.rb', line 293

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


280
281
282
# File 'lib/tripletex_api/models/address.rb', line 280

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



286
287
288
# File 'lib/tripletex_api/models/address.rb', line 286

def hash
  [id, version, changes, url, employee, address_line1, address_line2, postal_code, city, country, name].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
# File 'lib/tripletex_api/models/address.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  if !@address_line1.nil? && @address_line1.to_s.length > 255
    invalid_properties.push("invalid value for 'address_line1', the character length must be smaller than or equal to 255.")
  end

  if !@address_line1.nil? && @address_line1.to_s.length < 0
    invalid_properties.push("invalid value for 'address_line1', the character length must be great than or equal to 0.")
  end

  if !@address_line2.nil? && @address_line2.to_s.length > 255
    invalid_properties.push("invalid value for 'address_line2', the character length must be smaller than or equal to 255.")
  end

  if !@address_line2.nil? && @address_line2.to_s.length < 0
    invalid_properties.push("invalid value for 'address_line2', the character length must be great than or equal to 0.")
  end

  if !@postal_code.nil? && @postal_code.to_s.length > 100
    invalid_properties.push("invalid value for 'postal_code', the character length must be smaller than or equal to 100.")
  end

  if !@postal_code.nil? && @postal_code.to_s.length < 0
    invalid_properties.push("invalid value for 'postal_code', the character length must be great than or equal to 0.")
  end

  if !@city.nil? && @city.to_s.length > 100
    invalid_properties.push("invalid value for 'city', the character length must be smaller than or equal to 100.")
  end

  if !@city.nil? && @city.to_s.length < 0
    invalid_properties.push("invalid value for 'city', the character length must be great than or equal to 0.")
  end

  if !@name.nil? && @name.to_s.length > 100
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 100.")
  end

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



360
361
362
# File 'lib/tripletex_api/models/address.rb', line 360

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
# File 'lib/tripletex_api/models/address.rb', line 366

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



354
355
356
# File 'lib/tripletex_api/models/address.rb', line 354

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



176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/tripletex_api/models/address.rb', line 176

def valid?
  return false if !@address_line1.nil? && @address_line1.to_s.length > 255
  return false if !@address_line1.nil? && @address_line1.to_s.length < 0
  return false if !@address_line2.nil? && @address_line2.to_s.length > 255
  return false if !@address_line2.nil? && @address_line2.to_s.length < 0
  return false if !@postal_code.nil? && @postal_code.to_s.length > 100
  return false if !@postal_code.nil? && @postal_code.to_s.length < 0
  return false if !@city.nil? && @city.to_s.length > 100
  return false if !@city.nil? && @city.to_s.length < 0
  return false if !@name.nil? && @name.to_s.length > 100
  return true
end