Class: AmzSpApi::VendorShipmentsApiModel::ItemDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/vendor-shipments-api-model/models/item_details.rb

Overview

Item details for be provided for every item in shipment at either the item or carton or pallet level, whichever is appropriate.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ItemDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
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
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 82

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `AmzSpApi::VendorShipmentsApiModel::ItemDetails` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `AmzSpApi::VendorShipmentsApiModel::ItemDetails`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'purchase_order_number')
    self.purchase_order_number = attributes[:'purchase_order_number']
  end

  if attributes.key?(:'lot_number')
    self.lot_number = attributes[:'lot_number']
  end

  if attributes.key?(:'expiry')
    self.expiry = attributes[:'expiry']
  end

  if attributes.key?(:'maximum_retail_price')
    self.maximum_retail_price = attributes[:'maximum_retail_price']
  end

  if attributes.key?(:'handling_code')
    self.handling_code = attributes[:'handling_code']
  end
end

Instance Attribute Details

#expiry ⇒ Object

Returns the value of attribute expiry.



23
24
25
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 23

def expiry
  @expiry
end

#handling_code ⇒ Object

Identification of the instructions on how specified item/carton/pallet should be handled.



28
29
30
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 28

def handling_code
  @handling_code
end

#lot_number ⇒ Object

The batch or lot number associates an item with information the manufacturer considers relevant for traceability of the trade item to which the Element String is applied. The data may refer to the trade item itself or to items contained. This field is mandatory for all perishable items.



21
22
23
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 21

def lot_number
  @lot_number
end

#maximum_retail_price ⇒ Object

Returns the value of attribute maximum_retail_price.



25
26
27
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 25

def maximum_retail_price
  @maximum_retail_price
end

#purchase_order_number ⇒ Object

The Amazon purchase order number for the shipment being confirmed. If the items in this shipment belong to multiple purchase order numbers that are in particular carton or pallet within the shipment, then provide the purchaseOrderNumber at the appropriate carton or pallet level. Formatting Notes: 8-character alpha-numeric code.



18
19
20
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 18

def purchase_order_number
  @purchase_order_number
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



53
54
55
56
57
58
59
60
61
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 53

def self.attribute_map
  {
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'lot_number' => :'lotNumber',
    :'expiry' => :'expiry',
    :'maximum_retail_price' => :'maximumRetailPrice',
    :'handling_code' => :'handlingCode'
  }
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



168
169
170
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 168

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



75
76
77
78
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 75

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

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 64

def self.openapi_types
  {
    :'purchase_order_number' => :'Object',
    :'lot_number' => :'Object',
    :'expiry' => :'Object',
    :'maximum_retail_price' => :'Object',
    :'handling_code' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



143
144
145
146
147
148
149
150
151
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 143

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      purchase_order_number == o.purchase_order_number &&
      lot_number == o.lot_number &&
      expiry == o.expiry &&
      maximum_retail_price == o.maximum_retail_price &&
      handling_code == o.handling_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



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
230
231
232
233
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 198

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
    AmzSpApi::VendorShipmentsApiModel.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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 267

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 175

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
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


155
156
157
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



161
162
163
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 161

def hash
  [purchase_order_number, lot_number, expiry, maximum_retail_price, handling_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



118
119
120
121
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 118

def list_invalid_properties
  invalid_properties = Array.new
  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



243
244
245
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 243

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



249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 249

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



237
238
239
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 237

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



125
126
127
128
129
 
# File 'lib/vendor-shipments-api-model/models/item_details.rb', line 125

def valid?
  handling_code_validator = EnumAttributeValidator.new('Object', ['Oversized', 'Fragile', 'Food', 'HandleWithCare'])
  return false unless handling_code_validator.valid?(@handling_code)
  true
end