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

Raises:

  • (ArgumentError) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 58

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `AmznSpApi::MerchantFulfillmentApiModel::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::MerchantFulfillmentApiModel::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.district_or_county = attributes[:district_or_county] if attributes.key?(:district_or_county)

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

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

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

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

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

  return unless attributes.key?(:phone)

  self.phone = attributes[:phone]
end

Instance Attribute Details

#address_line1 ⇒ Object

Returns the value of attribute address_line1.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Returns the value of attribute address_line2.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

Returns the value of attribute address_line3.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def address_line3
  @address_line3
end

#city ⇒ Object

Returns the value of attribute city.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def city
  @city
end

#country_code ⇒ Object

Returns the value of attribute country_code.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def country_code
  @country_code
end

#district_or_county ⇒ Object

Returns the value of attribute district_or_county.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def district_or_county
  @district_or_county
end

#email ⇒ Object

Returns the value of attribute email.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def email
  @email
end

#name ⇒ Object

Returns the value of attribute name.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def name
  @name
end

#phone ⇒ Object

Returns the value of attribute phone.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def phone
  @phone
end

#postal_code ⇒ Object

Returns the value of attribute postal_code.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

def postal_code
  @postal_code
end

#state_or_province_code ⇒ Object

Returns the value of attribute state_or_province_code.



15
16
17
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 15

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.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 18

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



162
163
164
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 162

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 35

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

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 130

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 191

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



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

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



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 169

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


149
150
151
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 149

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 155

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



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

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

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

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

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

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

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

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



236
237
238
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 236

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 242

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



230
231
232
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 230

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



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/merchant_fulfillment_api_model/models/address.rb', line 116

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