Class: AmznSpApi::ServicesApiModel::Address

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

Overview

The shipping address for the service job.

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) 


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

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

The first line of the address.



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

def address_line1
  @address_line1
end

#address_line2 ⇒ Object

Additional address information, if required.



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

def address_line2
  @address_line2
end

#address_line3 ⇒ Object

Additional address information, if required.



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

def address_line3
  @address_line3
end

#city ⇒ Object

The city.



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

def city
  @city
end

#country_code ⇒ Object

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



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

def country_code
  @country_code
end

#county ⇒ Object

The county.



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

def county
  @county
end

#district ⇒ Object

The district.



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

def district
  @district
end

#name ⇒ Object

The name of the person, business, or institution.



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

def name
  @name
end

#phone ⇒ Object

The phone number.



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

def phone
  @phone
end

#postal_code ⇒ Object

The postal code. This can contain letters, digits, spaces, and/or punctuation.



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

def postal_code
  @postal_code
end

#state_or_region ⇒ Object

The state or region.



37
38
39
 
# File 'lib/services_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.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/services_api_model/models/address.rb', line 49

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,
    '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



178
179
180
 
# File 'lib/services_api_model/models/address.rb', line 178

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



83
84
85
 
# File 'lib/services_api_model/models/address.rb', line 83

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/services_api_model/models/address.rb', line 66

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,
    '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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/services_api_model/models/address.rb', line 146

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/services_api_model/models/address.rb', line 207

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/services_api_model/models/address.rb', line 276

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/services_api_model/models/address.rb', line 185

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


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

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



171
172
173
 
# File 'lib/services_api_model/models/address.rb', line 171

def hash
  [name, address_line1, address_line2, address_line3, city, county, district, state_or_region, 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



126
127
128
129
130
131
132
133
 
# File 'lib/services_api_model/models/address.rb', line 126

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
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
 
# File 'lib/services_api_model/models/address.rb', line 252

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



258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/services_api_model/models/address.rb', line 258

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



246
247
248
 
# File 'lib/services_api_model/models/address.rb', line 246

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



137
138
139
140
141
142
 
# File 'lib/services_api_model/models/address.rb', line 137

def valid?
  return false if @name.nil?
  return false if @address_line1.nil?

  true
end