Class: SwaggerClient::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_client/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



68
69
70
71
72
73
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
 
# File 'lib/swagger_client/models/address.rb', line 68

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

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

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

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

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

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

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

end

Instance Attribute Details

#address1 ⇒ Object

street address or P.O.Box number



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

def address1
  @address1
end

#address2 ⇒ Object

additional address information



25
26
27
 
# File 'lib/swagger_client/models/address.rb', line 25

def address2
  @address2
end

#city ⇒ Object

City or Locality



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

def city
  @city
end

#company ⇒ Object

If it’s a business, enter the name here.



19
20
21
 
# File 'lib/swagger_client/models/address.rb', line 19

def company
  @company
end

#country ⇒ Object

Country name



37
38
39
 
# File 'lib/swagger_client/models/address.rb', line 37

def country
  @country
end

#postal_code ⇒ Object

ZIP code or postal code



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

def postal_code
  @postal_code
end

#region ⇒ Object

State or Province



31
32
33
 
# File 'lib/swagger_client/models/address.rb', line 31

def region
  @region
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/swagger_client/models/address.rb', line 41

def self.attribute_map
  {
    :'company' => :'company',
    :'address1' => :'address1',
    :'address2' => :'address2',
    :'city' => :'city',
    :'region' => :'region',
    :'postal_code' => :'postalCode',
    :'country' => :'country'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/swagger_client/models/address.rb', line 54

def self.swagger_types
  {
    :'company' => :'String',
    :'address1' => :'String',
    :'address2' => :'String',
    :'city' => :'String',
    :'region' => :'String',
    :'postal_code' => :'String',
    :'country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/swagger_client/models/address.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      company == o.company &&
      address1 == o.address1 &&
      address2 == o.address2 &&
      city == o.city &&
      region == o.region &&
      postal_code == o.postal_code &&
      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



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

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 = SwaggerClient.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



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

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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/swagger_client/models/address.rb', line 258

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


245
246
247
 
# File 'lib/swagger_client/models/address.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



251
252
253
 
# File 'lib/swagger_client/models/address.rb', line 251

def hash
  [company, address1, address2, city, region, postal_code, 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



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

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

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

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

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

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

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

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

  return 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



325
326
327
 
# File 'lib/swagger_client/models/address.rb', line 325

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



331
332
333
334
335
336
337
338
339
 
# File 'lib/swagger_client/models/address.rb', line 331

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



319
320
321
 
# File 'lib/swagger_client/models/address.rb', line 319

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



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/swagger_client/models/address.rb', line 141

def valid?
  return false if !@company.nil? && @company.to_s.length > 96
  return false if !@address1.nil? && @address1.to_s.length > 96
  return false if !@address2.nil? && @address2.to_s.length > 96
  return false if !@city.nil? && @city.to_s.length > 96
  return false if !@region.nil? && @region.to_s.length > 96
  return false if !@postal_code.nil? && @postal_code.to_s.length > 24
  return false if !@country.nil? && @country.to_s.length > 32
  return true
end