Class: AmznSpApi::OrdersApiModel::Address

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

Overview

The shipping address for the order.

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

Raises:

  • (ArgumentError) 


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
152
153
154
155
156
157
 
# File 'lib/orders_api_model/models/address.rb', line 120

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::OrdersApiModel::Address` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `AmznSpApi::OrdersApiModel::Address`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

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

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

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

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

  self.city = attributes[:city] if attributes.key?(:city)

  self.county = attributes[:county] if attributes.key?(:county)

  self.district = attributes[:district] if attributes.key?(:district)

  self.state_or_region = attributes[:state_or_region] if attributes.key?(:state_or_region)

  self.municipality = attributes[:municipality] if attributes.key?(:municipality)

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

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

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

  return unless attributes.key?(:address_type)

  self.address_type = attributes[:address_type]
end

Instance Attribute Details

#address_line1 ⇒ Object

The street address.



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

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Additional street address information, if required.



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

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

Additional street address information, if required.



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

def address_line3
  @address_line3
end

#address_type ⇒ Object

The address type of the shipping address.



52
53
54
 
# File 'lib/orders_api_model/models/address.rb', line 52

def address_type
  @address_type
end

#city ⇒ Object

The city



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

def city
  @city
end

#country_code ⇒ Object

The country code. A two-character country code, in ISO 3166-1 alpha-2 format.



46
47
48
 
# File 'lib/orders_api_model/models/address.rb', line 46

def country_code
  @country_code
end

#county ⇒ Object

The county.



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

def county
  @county
end

#district ⇒ Object

The district.



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

def district
  @district
end

#municipality ⇒ Object

The municipality.



40
41
42
 
# File 'lib/orders_api_model/models/address.rb', line 40

def municipality
  @municipality
end

#name ⇒ Object

The name.



16
17
18
 
# File 'lib/orders_api_model/models/address.rb', line 16

def name
  @name
end

#phone ⇒ Object

The phone number. Not returned for Fulfillment by Amazon (FBA) orders.



49
50
51
 
# File 'lib/orders_api_model/models/address.rb', line 49

def phone
  @phone
end

#postal_code ⇒ Object

The postal code.



43
44
45
 
# File 'lib/orders_api_model/models/address.rb', line 43

def postal_code
  @postal_code
end

#state_or_region ⇒ Object

The state or region.



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

def state_or_region
  @state_or_region
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/orders_api_model/models/address.rb', line 76

def self.attribute_map
  {
    'name': :Name,
    'address_line1': :AddressLine1,
    'address_line2': :AddressLine2,
    'address_line3': :AddressLine3,
    'city': :City,
    'county': :County,
    'district': :District,
    'state_or_region': :StateOrRegion,
    'municipality': :Municipality,
    'postal_code': :PostalCode,
    'country_code': :CountryCode,
    'phone': :Phone,
    'address_type': :AddressType
  }
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



224
225
226
 
# File 'lib/orders_api_model/models/address.rb', line 224

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
 
# File 'lib/orders_api_model/models/address.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/orders_api_model/models/address.rb', line 95

def self.openapi_types
  {
    'name': :Object,
    'address_line1': :Object,
    'address_line2': :Object,
    'address_line3': :Object,
    'city': :Object,
    'county': :Object,
    'district': :Object,
    'state_or_region': :Object,
    'municipality': :Object,
    'postal_code': :Object,
    'country_code': :Object,
    'phone': :Object,
    'address_type': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/orders_api_model/models/address.rb', line 190

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    address_line1 == other.address_line1 &&
    address_line2 == other.address_line2 &&
    address_line3 == other.address_line3 &&
    city == other.city &&
    county == other.county &&
    district == other.district &&
    state_or_region == other.state_or_region &&
    municipality == other.municipality &&
    postal_code == other.postal_code &&
    country_code == other.country_code &&
    phone == other.phone &&
    address_type == other.address_type
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



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

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
    AmznSpApi::OrdersApiModel.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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/orders_api_model/models/address.rb', line 322

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/orders_api_model/models/address.rb', line 231

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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{key}=", nil)
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/orders_api_model/models/address.rb', line 211

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/orders_api_model/models/address.rb', line 217

def hash
  [name, address_line1, address_line2, address_line3, city, county, district, state_or_region, municipality, postal_code, country_code, phone, address_type].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



161
162
163
164
165
166
 
# File 'lib/orders_api_model/models/address.rb', line 161

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "name", name cannot be nil.') if @name.nil?

  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



298
299
300
 
# File 'lib/orders_api_model/models/address.rb', line 298

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



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/orders_api_model/models/address.rb', line 304

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



292
293
294
 
# File 'lib/orders_api_model/models/address.rb', line 292

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



170
171
172
173
174
175
176
177
 
# File 'lib/orders_api_model/models/address.rb', line 170

def valid?
  return false if @name.nil?

  address_type_validator = EnumAttributeValidator.new('Object', %w[Residential Commercial])
  return false unless address_type_validator.valid?(@address_type)

  true
end