Class: AmznSpApi::ShippingApiModel::Location

Inherits:
Object
  • Object
show all
Defined in:
lib/shipping_api_model/models/location.rb

Overview

The location where the person, business or institution is located.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Location

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/shipping_api_model/models/location.rb', line 44

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

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

  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

#city ⇒ Object

Returns the value of attribute city.



15
16
17
 
# File 'lib/shipping_api_model/models/location.rb', line 15

def city
  @city
end

#country_code ⇒ Object

Returns the value of attribute country_code.



15
16
17
 
# File 'lib/shipping_api_model/models/location.rb', line 15

def country_code
  @country_code
end

#postal_code ⇒ Object

Returns the value of attribute postal_code.



15
16
17
 
# File 'lib/shipping_api_model/models/location.rb', line 15

def postal_code
  @postal_code
end

#state_or_region ⇒ Object

Returns the value of attribute state_or_region.



15
16
17
 
# File 'lib/shipping_api_model/models/location.rb', line 15

def state_or_region
  @state_or_region
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
 
# File 'lib/shipping_api_model/models/location.rb', line 18

def self.attribute_map
  {
    'state_or_region': :stateOrRegion,
    'city': :city,
    '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



104
105
106
 
# File 'lib/shipping_api_model/models/location.rb', line 104

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



38
39
40
 
# File 'lib/shipping_api_model/models/location.rb', line 38

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

.openapi_types ⇒ Object

Attribute type mapping.



28
29
30
31
32
33
34
35
 
# File 'lib/shipping_api_model/models/location.rb', line 28

def self.openapi_types
  {
    'state_or_region': :Object,
    'city': :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



79
80
81
82
83
84
85
86
87
 
# File 'lib/shipping_api_model/models/location.rb', line 79

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

  self.class == other.class &&
    state_or_region == other.state_or_region &&
    city == other.city &&
    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



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
 
# File 'lib/shipping_api_model/models/location.rb', line 133

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



202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/shipping_api_model/models/location.rb', line 202

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/shipping_api_model/models/location.rb', line 111

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


91
92
93
 
# File 'lib/shipping_api_model/models/location.rb', line 91

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



97
98
99
 
# File 'lib/shipping_api_model/models/location.rb', line 97

def hash
  [state_or_region, city, 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



67
68
69
 
# File 'lib/shipping_api_model/models/location.rb', line 67

def list_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



178
179
180
 
# File 'lib/shipping_api_model/models/location.rb', line 178

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



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/shipping_api_model/models/location.rb', line 184

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



172
173
174
 
# File 'lib/shipping_api_model/models/location.rb', line 172

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



73
74
75
 
# File 'lib/shipping_api_model/models/location.rb', line 73

def valid?
  true
end