Class: ShipEngine::PartialAddress

Inherits:
Object
  • Object
show all
Defined in:
lib/ship_engine/models/partial_address.rb

Overview

A complete or partial mailing address.

Direct Known Subclasses

Address, AddressToValidate

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PartialAddress

Initializes the object



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/ship_engine/models/partial_address.rb', line 97

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `ShipEngine::PartialAddress` 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|

    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_line1 ⇒ Object

The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.



28
29
30
 
# File 'lib/ship_engine/models/partial_address.rb', line 28

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

The second line of the street address. For some addresses, this line may not be needed.



31
32
33
 
# File 'lib/ship_engine/models/partial_address.rb', line 31

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

The third line of the street address. For some addresses, this line may not be needed.



34
35
36
 
# File 'lib/ship_engine/models/partial_address.rb', line 34

def address_line3
  @address_line3
end

#address_residential_indicator ⇒ Object

Indicates whether this is a residential address.



48
49
50
 
# File 'lib/ship_engine/models/partial_address.rb', line 48

def address_residential_indicator
  @address_residential_indicator
end

#city_locality ⇒ Object

The name of the city or locality



37
38
39
 
# File 'lib/ship_engine/models/partial_address.rb', line 37

def city_locality
  @city_locality
end

#company_name ⇒ Object

If this is a business address, then the company name should be specified here.



25
26
27
 
# File 'lib/ship_engine/models/partial_address.rb', line 25

def company_name
  @company_name
end

#country_code ⇒ Object

The two-letter [ISO 3166-1 country code](en.wikipedia.org/wiki/ISO_3166-1)



45
46
47
 
# File 'lib/ship_engine/models/partial_address.rb', line 45

def country_code
  @country_code
end

#name ⇒ Object

The name of a contact person at this address. This field may be set instead of - or in addition to - the ‘company_name` field.



19
20
21
 
# File 'lib/ship_engine/models/partial_address.rb', line 19

def name
  @name
end

#phone ⇒ Object

The phone number of a contact person at this address. The format of this phone number varies depending on the country.



22
23
24
 
# File 'lib/ship_engine/models/partial_address.rb', line 22

def phone
  @phone
end

#postal_code ⇒ Object

Returns the value of attribute postal_code.



42
43
44
 
# File 'lib/ship_engine/models/partial_address.rb', line 42

def postal_code
  @postal_code
end

#state_province ⇒ Object

The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.



40
41
42
 
# File 'lib/ship_engine/models/partial_address.rb', line 40

def state_province
  @state_province
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ship_engine/models/partial_address.rb', line 51

def self.attribute_map
  {
    :'name' => :'name',
    :'phone' => :'phone',
    :'company_name' => :'company_name',
    :'address_line1' => :'address_line1',
    :'address_line2' => :'address_line2',
    :'address_line3' => :'address_line3',
    :'city_locality' => :'city_locality',
    :'state_province' => :'state_province',
    :'postal_code' => :'postal_code',
    :'country_code' => :'country_code',
    :'address_residential_indicator' => :'address_residential_indicator'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



319
320
321
 
# File 'lib/ship_engine/models/partial_address.rb', line 319

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



85
86
87
88
89
90
91
92
93
 
# File 'lib/ship_engine/models/partial_address.rb', line 85

def self.openapi_nullable
  Set.new([
    :'name',
    :'phone',
    :'company_name',
    :'address_line2',
    :'address_line3',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/ship_engine/models/partial_address.rb', line 68

def self.openapi_types
  {
    :'name' => :'String',
    :'phone' => :'String',
    :'company_name' => :'String',
    :'address_line1' => :'String',
    :'address_line2' => :'String',
    :'address_line3' => :'String',
    :'city_locality' => :'String',
    :'state_province' => :'String',
    :'postal_code' => :'String',
    :'country_code' => :'String',
    :'address_residential_indicator' => :'AddressResidentialIndicator'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/ship_engine/models/partial_address.rb', line 288

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      phone == o.phone &&
      company_name == o.company_name &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_line3 == o.address_line3 &&
      city_locality == o.city_locality &&
      state_province == o.state_province &&
      postal_code == o.postal_code &&
      country_code == o.country_code &&
      address_residential_indicator == o.address_residential_indicator
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/ship_engine/models/partial_address.rb', line 347

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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/ship_engine/models/partial_address.rb', line 416

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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ship_engine/models/partial_address.rb', line 326

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

See Also:

  • `==` method


306
307
308
 
# File 'lib/ship_engine/models/partial_address.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



312
313
314
 
# File 'lib/ship_engine/models/partial_address.rb', line 312

def hash
  [name, phone, company_name, address_line1, address_line2, address_line3, city_locality, state_province, postal_code, country_code, address_residential_indicator].hash
end

#list_invalid_properties ⇒ Object

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



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
 
# File 'lib/ship_engine/models/partial_address.rb', line 155

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



392
393
394
 
# File 'lib/ship_engine/models/partial_address.rb', line 392

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/ship_engine/models/partial_address.rb', line 398

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



386
387
388
 
# File 'lib/ship_engine/models/partial_address.rb', line 386

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/ship_engine/models/partial_address.rb', line 194

def valid?
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@phone.nil? && @phone.to_s.length < 1
  return false if !@company_name.nil? && @company_name.to_s.length < 1
  return false if !@address_line1.nil? && @address_line1.to_s.length < 1
  return false if !@address_line2.nil? && @address_line2.to_s.length < 1
  return false if !@address_line3.nil? && @address_line3.to_s.length < 1
  return false if !@city_locality.nil? && @city_locality.to_s.length < 1
  return false if !@state_province.nil? && @state_province.to_s.length < 1
  true
end