Class: AmzSpApi::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



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
 
# File 'lib/orders-api-model/models/address.rb', line 124

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

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

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

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

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

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

Instance Attribute Details

#address_line1 ⇒ Object

The street address.



21
22
23
 
# File 'lib/orders-api-model/models/address.rb', line 21

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Additional street address information, if required.



24
25
26
 
# File 'lib/orders-api-model/models/address.rb', line 24

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

Additional street address information, if required.



27
28
29
 
# File 'lib/orders-api-model/models/address.rb', line 27

def address_line3
  @address_line3
end

#address_type ⇒ Object

The address type of the shipping address.



54
55
56
 
# File 'lib/orders-api-model/models/address.rb', line 54

def address_type
  @address_type
end

#city ⇒ Object

The city



30
31
32
 
# File 'lib/orders-api-model/models/address.rb', line 30

def city
  @city
end

#country_code ⇒ Object

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



48
49
50
 
# File 'lib/orders-api-model/models/address.rb', line 48

def country_code
  @country_code
end

#county ⇒ Object

The county.



33
34
35
 
# File 'lib/orders-api-model/models/address.rb', line 33

def county
  @county
end

#district ⇒ Object

The district.



36
37
38
 
# File 'lib/orders-api-model/models/address.rb', line 36

def district
  @district
end

#municipality ⇒ Object

The municipality.



42
43
44
 
# File 'lib/orders-api-model/models/address.rb', line 42

def municipality
  @municipality
end

#name ⇒ Object

The name.



18
19
20
 
# File 'lib/orders-api-model/models/address.rb', line 18

def name
  @name
end

#phone ⇒ Object

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



51
52
53
 
# File 'lib/orders-api-model/models/address.rb', line 51

def phone
  @phone
end

#postal_code ⇒ Object

The postal code.



45
46
47
 
# File 'lib/orders-api-model/models/address.rb', line 45

def postal_code
  @postal_code
end

#state_or_region ⇒ Object

The state or region.



39
40
41
 
# File 'lib/orders-api-model/models/address.rb', line 39

def state_or_region
  @state_or_region
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/orders-api-model/models/address.rb', line 79

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



255
256
257
 
# File 'lib/orders-api-model/models/address.rb', line 255

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/orders-api-model/models/address.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/orders-api-model/models/address.rb', line 98

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

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/orders-api-model/models/address.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      address_line1 == o.address_line1 &&
      address_line2 == o.address_line2 &&
      address_line3 == o.address_line3 &&
      city == o.city &&
      county == o.county &&
      district == o.district &&
      state_or_region == o.state_or_region &&
      municipality == o.municipality &&
      postal_code == o.postal_code &&
      country_code == o.country_code &&
      phone == o.phone &&
      address_type == o.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



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
316
317
318
319
320
 
# File 'lib/orders-api-model/models/address.rb', line 285

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
    AmzSpApi::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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/orders-api-model/models/address.rb', line 354

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/orders-api-model/models/address.rb', line 262

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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


242
243
244
 
# File 'lib/orders-api-model/models/address.rb', line 242

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



248
249
250
 
# File 'lib/orders-api-model/models/address.rb', line 248

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



192
193
194
195
196
197
198
199
 
# File 'lib/orders-api-model/models/address.rb', line 192

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

  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



330
331
332
 
# File 'lib/orders-api-model/models/address.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/orders-api-model/models/address.rb', line 336

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



324
325
326
 
# File 'lib/orders-api-model/models/address.rb', line 324

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



203
204
205
206
207
208
 
# File 'lib/orders-api-model/models/address.rb', line 203

def valid?
  return false if @name.nil?
  address_type_validator = EnumAttributeValidator.new('Object', ['Residential', 'Commercial'])
  return false unless address_type_validator.valid?(@address_type)
  true
end