Class: AmznSpApi::FulfillmentInboundApiModel::Address

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

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) 


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 73

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

  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.country_code = attributes[:country_code] if attributes.key?(:country_code)

  return unless attributes.key?(:postal_code)

  self.postal_code = attributes[:postal_code]
end

Instance Attribute Details

#address_line1 ⇒ Object

The street address information.



18
19
20
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 18

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Additional street address information, if required.



21
22
23
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 21

def address_line2
  @address_line2
end

#city ⇒ Object

The city.



27
28
29
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 27

def city
  @city
end

#country_code ⇒ Object

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



33
34
35
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 33

def country_code
  @country_code
end

#district_or_county ⇒ Object

The district or county.



24
25
26
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 24

def district_or_county
  @district_or_county
end

#name ⇒ Object

Name of the individual or business.



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

def name
  @name
end

#postal_code ⇒ Object

The postal code. If postal codes are used in your marketplace, we recommended that you include one with your request. This helps Amazon select the most appropriate Amazon fulfillment center for the inbound shipment plan.



36
37
38
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 36

def postal_code
  @postal_code
end

#state_or_province_code ⇒ Object

The state or province code. If state or province codes are used in your marketplace, it is recommended that you include one with your request. This helps Amazon to select the most appropriate Amazon fulfillment center for your inbound shipment plan.



30
31
32
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 30

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.



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 39

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



165
166
167
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 165

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 67

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

.openapi_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 53

def self.openapi_types
  {
    'name': :Object,
    'address_line1': :Object,
    'address_line2': :Object,
    'district_or_county': :Object,
    'city': :Object,
    'state_or_province_code': :Object,
    'country_code': :Object,
    'postal_code': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 136

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

  self.class == other.class &&
    name == other.name &&
    address_line1 == other.address_line1 &&
    address_line2 == other.address_line2 &&
    district_or_county == other.district_or_county &&
    city == other.city &&
    state_or_province_code == other.state_or_province_code &&
    country_code == other.country_code &&
    postal_code == other.postal_code
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



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
227
228
229
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 194

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 263

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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 172

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


152
153
154
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 152

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 158

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 104

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 "city", city cannot be nil.') if @city.nil?

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



239
240
241
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 239

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



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 245

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



233
234
235
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 233

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



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/fulfillment_inbound_api_model/models/address.rb', line 123

def valid?
  return false if @name.nil?
  return false if @address_line1.nil?
  return false if @city.nil?
  return false if @state_or_province_code.nil?
  return false if @country_code.nil?
  return false if @postal_code.nil?

  true
end