Class: AmzSpApi::MerchantFulfillmentApiModel::Address

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant-fulfillment-api-model/models/address.rb

Overview

The postal address information.

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



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
130
131
132
133
134
135
136
137
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 81

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

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

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

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

Instance Attribute Details

#address_line1 ⇒ Object

Returns the value of attribute address_line1.



19
20
21
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 19

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Returns the value of attribute address_line2.



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

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

Returns the value of attribute address_line3.



23
24
25
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 23

def address_line3
  @address_line3
end

#city ⇒ Object

Returns the value of attribute city.



29
30
31
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 29

def city
  @city
end

#country_code ⇒ Object

Returns the value of attribute country_code.



35
36
37
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 35

def country_code
  @country_code
end

#district_or_county ⇒ Object

Returns the value of attribute district_or_county.



25
26
27
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 25

def district_or_county
  @district_or_county
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#name ⇒ Object

Returns the value of attribute name.



17
18
19
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 17

def name
  @name
end

#phone ⇒ Object

Returns the value of attribute phone.



37
38
39
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 37

def phone
  @phone
end

#postal_code ⇒ Object

Returns the value of attribute postal_code.



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

def postal_code
  @postal_code
end

#state_or_province_code ⇒ Object

Returns the value of attribute state_or_province_code.



31
32
33
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 31

def state_or_province_code
  @state_or_province_code
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 40

def self.attribute_map
  {
    :'name' => :'Name',
    :'address_line1' => :'AddressLine1',
    :'address_line2' => :'AddressLine2',
    :'address_line3' => :'AddressLine3',
    :'district_or_county' => :'DistrictOrCounty',
    :'email' => :'Email',
    :'city' => :'City',
    :'state_or_province_code' => :'StateOrProvinceCode',
    :'postal_code' => :'PostalCode',
    :'country_code' => :'CountryCode',
    :'phone' => :'Phone'
  }
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



220
221
222
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 220

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



74
75
76
77
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 74

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

.openapi_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 57

def self.openapi_types
  {
    :'name' => :'Object',
    :'address_line1' => :'Object',
    :'address_line2' => :'Object',
    :'address_line3' => :'Object',
    :'district_or_county' => :'Object',
    :'email' => :'Object',
    :'city' => :'Object',
    :'state_or_province_code' => :'Object',
    :'postal_code' => :'Object',
    :'country_code' => :'Object',
    :'phone' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 189

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 &&
      district_or_county == o.district_or_county &&
      email == o.email &&
      city == o.city &&
      state_or_province_code == o.state_or_province_code &&
      postal_code == o.postal_code &&
      country_code == o.country_code &&
      phone == o.phone
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



250
251
252
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
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 250

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::MerchantFulfillmentApiModel.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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 319

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 227

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


207
208
209
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 213

def hash
  [name, address_line1, address_line2, address_line3, district_or_county, email, city, state_or_province_code, postal_code, country_code, phone].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



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/merchant-fulfillment-api-model/models/address.rb', line 141

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

  if @address_line1.nil?
    invalid_properties.push('invalid value for "address_line1", address_line1 cannot be nil.')
  end

  if @email.nil?
    invalid_properties.push('invalid value for "email", email cannot be nil.')
  end

  if @city.nil?
    invalid_properties.push('invalid value for "city", city cannot be nil.')
  end

  if @postal_code.nil?
    invalid_properties.push('invalid value for "postal_code", postal_code cannot be nil.')
  end

  if @country_code.nil?
    invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
  end

  if @phone.nil?
    invalid_properties.push('invalid value for "phone", phone 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



295
296
297
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 295

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



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 301

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



289
290
291
 
# File 'lib/merchant-fulfillment-api-model/models/address.rb', line 289

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

def valid?
  return false if @name.nil?
  return false if @address_line1.nil?
  return false if @email.nil?
  return false if @city.nil?
  return false if @postal_code.nil?
  return false if @country_code.nil?
  return false if @phone.nil?
  true
end