Class: AmznSpApi::MerchantFulfillmentApiModel::Item

Inherits:
Object
  • Object
show all
Defined in:
lib/merchant_fulfillment_api_model/models/item.rb

Overview

An Amazon order item identifier and a quantity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Item

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 48

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

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

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

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

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

  return unless attributes.key?(:item_level_seller_inputs_list)

  self.item_level_seller_inputs_list = attributes[:item_level_seller_inputs_list]
end

Instance Attribute Details

#item_description ⇒ Object

Returns the value of attribute item_description.



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

def item_description
  @item_description
end

#item_level_seller_inputs_list ⇒ Object

Returns the value of attribute item_level_seller_inputs_list.



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

def item_level_seller_inputs_list
  @item_level_seller_inputs_list
end

#item_weight ⇒ Object

Returns the value of attribute item_weight.



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

def item_weight
  @item_weight
end

#order_item_id ⇒ Object

Returns the value of attribute order_item_id.



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

def order_item_id
  @order_item_id
end

#quantity ⇒ Object

Returns the value of attribute quantity.



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

def quantity
  @quantity
end

#transparency_code_list ⇒ Object

Returns the value of attribute transparency_code_list.



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

def transparency_code_list
  @transparency_code_list
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
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 18

def self.attribute_map
  {
    'order_item_id': :OrderItemId,
    'quantity': :Quantity,
    'item_weight': :ItemWeight,
    'item_description': :ItemDescription,
    'transparency_code_list': :TransparencyCodeList,
    'item_level_seller_inputs_list': :ItemLevelSellerInputsList
  }
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



122
123
124
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 122

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



42
43
44
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 42

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

.openapi_types ⇒ Object

Attribute type mapping.



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 30

def self.openapi_types
  {
    'order_item_id': :Object,
    'quantity': :Object,
    'item_weight': :Object,
    'item_description': :Object,
    'transparency_code_list': :Object,
    'item_level_seller_inputs_list': :Object
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 95

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

  self.class == other.class &&
    order_item_id == other.order_item_id &&
    quantity == other.quantity &&
    item_weight == other.item_weight &&
    item_description == other.item_description &&
    transparency_code_list == other.transparency_code_list &&
    item_level_seller_inputs_list == other.item_level_seller_inputs_list
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 151

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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 220

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



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

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


109
110
111
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



115
116
117
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 115

def hash
  [order_item_id, quantity, item_weight, item_description, transparency_code_list, item_level_seller_inputs_list].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



75
76
77
78
79
80
81
82
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 75

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

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



196
197
198
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 196

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



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

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



190
191
192
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 190

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



86
87
88
89
90
91
 
# File 'lib/merchant_fulfillment_api_model/models/item.rb', line 86

def valid?
  return false if @order_item_id.nil?
  return false if @quantity.nil?

  true
end