Class: OpenapiClient::ShipmentItem

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/shipment_item.rb

Overview

A shipment item

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ShipmentItem

Initializes the object



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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/openapi_client/models/shipment_item.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ShipmentItem` 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 `OpenapiClient::ShipmentItem`. 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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#asin ⇒ Object

Amazon Standard Identification Number



40
41
42
 
# File 'lib/openapi_client/models/shipment_item.rb', line 40

def asin
  @asin
end

#external_order_id ⇒ Object

external order id



34
35
36
 
# File 'lib/openapi_client/models/shipment_item.rb', line 34

def external_order_id
  @external_order_id
end

#external_order_item_id ⇒ Object

external order item id



37
38
39
 
# File 'lib/openapi_client/models/shipment_item.rb', line 37

def external_order_item_id
  @external_order_item_id
end

#name ⇒ Object

item name



19
20
21
 
# File 'lib/openapi_client/models/shipment_item.rb', line 19

def name
  @name
end

#order_source_code ⇒ Object

Returns the value of attribute order_source_code.



42
43
44
 
# File 'lib/openapi_client/models/shipment_item.rb', line 42

def order_source_code
  @order_source_code
end

#quantity ⇒ Object

The quantity of this item included in the shipment



28
29
30
 
# File 'lib/openapi_client/models/shipment_item.rb', line 28

def quantity
  @quantity
end

#sales_order_id ⇒ Object

sales order id



22
23
24
 
# File 'lib/openapi_client/models/shipment_item.rb', line 22

def sales_order_id
  @sales_order_id
end

#sales_order_item_id ⇒ Object

sales order item id



25
26
27
 
# File 'lib/openapi_client/models/shipment_item.rb', line 25

def sales_order_item_id
  @sales_order_item_id
end

#sku ⇒ Object

Item Stock Keeping Unit



31
32
33
 
# File 'lib/openapi_client/models/shipment_item.rb', line 31

def sku
  @sku
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/openapi_client/models/shipment_item.rb', line 45

def self.attribute_map
  {
    :'name' => :'name',
    :'sales_order_id' => :'sales_order_id',
    :'sales_order_item_id' => :'sales_order_item_id',
    :'quantity' => :'quantity',
    :'sku' => :'sku',
    :'external_order_id' => :'external_order_id',
    :'external_order_item_id' => :'external_order_item_id',
    :'asin' => :'asin',
    :'order_source_code' => :'order_source_code'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



236
237
238
 
# File 'lib/openapi_client/models/shipment_item.rb', line 236

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
79
80
81
82
83
84
 
# File 'lib/openapi_client/models/shipment_item.rb', line 75

def self.openapi_nullable
  Set.new([
    :'sales_order_id',
    :'sales_order_item_id',
    :'sku',
    :'external_order_id',
    :'external_order_item_id',
    :'asin',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/openapi_client/models/shipment_item.rb', line 60

def self.openapi_types
  {
    :'name' => :'String',
    :'sales_order_id' => :'String',
    :'sales_order_item_id' => :'String',
    :'quantity' => :'Integer',
    :'sku' => :'String',
    :'external_order_id' => :'String',
    :'external_order_item_id' => :'String',
    :'asin' => :'String',
    :'order_source_code' => :'OrderSourceName'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/openapi_client/models/shipment_item.rb', line 207

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      sales_order_id == o.sales_order_id &&
      sales_order_item_id == o.sales_order_item_id &&
      quantity == o.quantity &&
      sku == o.sku &&
      external_order_id == o.external_order_id &&
      external_order_item_id == o.external_order_item_id &&
      asin == o.asin &&
      order_source_code == o.order_source_code
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/openapi_client/models/shipment_item.rb', line 264

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
    OpenapiClient.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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/openapi_client/models/shipment_item.rb', line 333

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/openapi_client/models/shipment_item.rb', line 243

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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


223
224
225
 
# File 'lib/openapi_client/models/shipment_item.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



229
230
231
 
# File 'lib/openapi_client/models/shipment_item.rb', line 229

def hash
  [name, sales_order_id, sales_order_item_id, quantity, sku, external_order_id, external_order_item_id, asin, order_source_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/openapi_client/models/shipment_item.rb', line 140

def list_invalid_properties
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length < 0
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 0.')
  end

  if !@quantity.nil? && @quantity < 0
    invalid_properties.push('invalid value for "quantity", must be greater than or equal to 0.')
  end

  if !@asin.nil? && @asin.to_s.length > 10
    invalid_properties.push('invalid value for "asin", the character length must be smaller than or equal to 10.')
  end

  if !@asin.nil? && @asin.to_s.length < 10
    invalid_properties.push('invalid value for "asin", the character length must be great than or equal to 10.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



309
310
311
 
# File 'lib/openapi_client/models/shipment_item.rb', line 309

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/openapi_client/models/shipment_item.rb', line 315

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



303
304
305
 
# File 'lib/openapi_client/models/shipment_item.rb', line 303

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



163
164
165
166
167
168
169
 
# File 'lib/openapi_client/models/shipment_item.rb', line 163

def valid?
  return false if !@name.nil? && @name.to_s.length < 0
  return false if !@quantity.nil? && @quantity < 0
  return false if !@asin.nil? && @asin.to_s.length > 10
  return false if !@asin.nil? && @asin.to_s.length < 10
  true
end