Class: AmzSpApi::VendorInvoicesApiModel::InvoiceItem

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

Overview

Details of the item being invoiced.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvoiceItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 89

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

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

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

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

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

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

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

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

  if attributes.key?(:'tax_details')
    if (value = attributes[:'tax_details']).is_a?(Array)
      self.tax_details = value
    end
  end

  if attributes.key?(:'charge_details')
    if (value = attributes[:'charge_details']).is_a?(Array)
      self.charge_details = value
    end
  end

  if attributes.key?(:'allowance_details')
    if (value = attributes[:'allowance_details']).is_a?(Array)
      self.allowance_details = value
    end
  end
end

Instance Attribute Details

#allowance_details ⇒ Object

Individual allowance details per line item.



45
46
47
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 45

def allowance_details
  @allowance_details
end

#amazon_product_identifier ⇒ Object

Amazon Standard Identification Number (ASIN) of an item.



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

def amazon_product_identifier
  @amazon_product_identifier
end

#charge_details ⇒ Object

Individual charge details per line item.



42
43
44
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 42

def charge_details
  @charge_details
end

#credit_note_details ⇒ Object

Returns the value of attribute credit_note_details.



36
37
38
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 36

def credit_note_details
  @credit_note_details
end

#hsn_code ⇒ Object

HSN Tax code. The HSN number cannot contain alphabets.



34
35
36
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 34

def hsn_code
  @hsn_code
end

#invoiced_quantity ⇒ Object

Returns the value of attribute invoiced_quantity.



26
27
28
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 26

def invoiced_quantity
  @invoiced_quantity
end

#item_sequence_number ⇒ Object

Unique number related to this line item.



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

def item_sequence_number
  @item_sequence_number
end

#net_cost ⇒ Object

Returns the value of attribute net_cost.



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

def net_cost
  @net_cost
end

#purchase_order_number ⇒ Object

The Amazon purchase order number for this invoiced line item. Formatting Notes: 8-character alpha-numeric code. This value is mandatory only when invoiceType is Invoice, and is not required when invoiceType is CreditNote.



31
32
33
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 31

def purchase_order_number
  @purchase_order_number
end

#tax_details ⇒ Object

Individual tax details per line item.



39
40
41
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 39

def tax_details
  @tax_details
end

#vendor_product_identifier ⇒ Object

The vendor selected product identifier of the item. Should be the same as was provided in the purchase order.



24
25
26
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 24

def vendor_product_identifier
  @vendor_product_identifier
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 48

def self.attribute_map
  {
    :'item_sequence_number' => :'itemSequenceNumber',
    :'amazon_product_identifier' => :'amazonProductIdentifier',
    :'vendor_product_identifier' => :'vendorProductIdentifier',
    :'invoiced_quantity' => :'invoicedQuantity',
    :'net_cost' => :'netCost',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'hsn_code' => :'hsnCode',
    :'credit_note_details' => :'creditNoteDetails',
    :'tax_details' => :'taxDetails',
    :'charge_details' => :'chargeDetails',
    :'allowance_details' => :'allowanceDetails'
  }
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



214
215
216
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 214

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 65

def self.openapi_types
  {
    :'item_sequence_number' => :'Object',
    :'amazon_product_identifier' => :'Object',
    :'vendor_product_identifier' => :'Object',
    :'invoiced_quantity' => :'Object',
    :'net_cost' => :'Object',
    :'purchase_order_number' => :'Object',
    :'hsn_code' => :'Object',
    :'credit_note_details' => :'Object',
    :'tax_details' => :'Object',
    :'charge_details' => :'Object',
    :'allowance_details' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_sequence_number == o.item_sequence_number &&
      amazon_product_identifier == o.amazon_product_identifier &&
      vendor_product_identifier == o.vendor_product_identifier &&
      invoiced_quantity == o.invoiced_quantity &&
      net_cost == o.net_cost &&
      purchase_order_number == o.purchase_order_number &&
      hsn_code == o.hsn_code &&
      credit_note_details == o.credit_note_details &&
      tax_details == o.tax_details &&
      charge_details == o.charge_details &&
      allowance_details == o.allowance_details
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 244

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 313

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 221

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


201
202
203
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 207

def hash
  [item_sequence_number, amazon_product_identifier, vendor_product_identifier, invoiced_quantity, net_cost, purchase_order_number, hsn_code, credit_note_details, tax_details, charge_details, allowance_details].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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  if @item_sequence_number.nil?
    invalid_properties.push('invalid value for "item_sequence_number", item_sequence_number cannot be nil.')
  end

  if @invoiced_quantity.nil?
    invalid_properties.push('invalid value for "invoiced_quantity", invoiced_quantity cannot be nil.')
  end

  if @net_cost.nil?
    invalid_properties.push('invalid value for "net_cost", net_cost cannot be nil.')
  end

  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



289
290
291
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 295

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



283
284
285
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 283

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



174
175
176
177
178
179
 
# File 'lib/vendor-invoices-api-model/models/invoice_item.rb', line 174

def valid?
  return false if @item_sequence_number.nil?
  return false if @invoiced_quantity.nil?
  return false if @net_cost.nil?
  true
end