Class: AmzSpApi::VendorDirectFulfillmentPaymentsApiModel::InvoiceItem

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

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



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
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
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 84

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

  if attributes.key?(:'hsn_code')
    self.hsn_code = attributes[:'hsn_code']
  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
end

Instance Attribute Details

#buyer_product_identifier ⇒ Object

Buyer’s standard identification number (ASIN) of an item.



20
21
22
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 20

def buyer_product_identifier
  @buyer_product_identifier
end

#charge_details ⇒ Object

Individual charge details per line item.



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

def charge_details
  @charge_details
end

#hsn_code ⇒ Object

HSN tax code. The HSN number cannot contain alphabets.



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

def hsn_code
  @hsn_code
end

#invoiced_quantity ⇒ Object

Returns the value of attribute invoiced_quantity.



25
26
27
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 25

def invoiced_quantity
  @invoiced_quantity
end

#item_sequence_number ⇒ Object

Numbering of the item on the purchase order. The first item will be 1, the second 2, and so on.



17
18
19
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 17

def item_sequence_number
  @item_sequence_number
end

#net_cost ⇒ Object

Returns the value of attribute net_cost.



27
28
29
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 27

def net_cost
  @net_cost
end

#purchase_order_number ⇒ Object

The purchase order number for this order. Formatting Notes: 8-character alpha-numeric code.



30
31
32
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 30

def purchase_order_number
  @purchase_order_number
end

#tax_details ⇒ Object

Individual tax details per line item.



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

def tax_details
  @tax_details
end

#vendor_order_number ⇒ Object

The vendor’s order number for this order.



33
34
35
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 33

def vendor_order_number
  @vendor_order_number
end

#vendor_product_identifier ⇒ Object

The vendor selected product identification of the item.



23
24
25
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 23

def vendor_product_identifier
  @vendor_product_identifier
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
58
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 45

def self.attribute_map
  {
    :'item_sequence_number' => :'itemSequenceNumber',
    :'buyer_product_identifier' => :'buyerProductIdentifier',
    :'vendor_product_identifier' => :'vendorProductIdentifier',
    :'invoiced_quantity' => :'invoicedQuantity',
    :'net_cost' => :'netCost',
    :'purchase_order_number' => :'purchaseOrderNumber',
    :'vendor_order_number' => :'vendorOrderNumber',
    :'hsn_code' => :'hsnCode',
    :'tax_details' => :'taxDetails',
    :'charge_details' => :'chargeDetails'
  }
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



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 61

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      item_sequence_number == o.item_sequence_number &&
      buyer_product_identifier == o.buyer_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 &&
      vendor_order_number == o.vendor_order_number &&
      hsn_code == o.hsn_code &&
      tax_details == o.tax_details &&
      charge_details == o.charge_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



237
238
239
240
241
242
243
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
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 237

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



306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 306

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 214

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


194
195
196
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 200

def hash
  [item_sequence_number, buyer_product_identifier, vendor_product_identifier, invoiced_quantity, net_cost, purchase_order_number, vendor_order_number, hsn_code, tax_details, charge_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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 144

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

  if @purchase_order_number.nil?
    invalid_properties.push('invalid value for "purchase_order_number", purchase_order_number 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



282
283
284
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 282

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



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 288

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



276
277
278
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 276

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



167
168
169
170
171
172
173
 
# File 'lib/vendor-direct-fulfillment-payments-api-model/models/invoice_item.rb', line 167

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