Class: Wallee::LineItem

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/line_item.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LineItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



142
143
144
145
146
147
148
149
150
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
187
188
189
190
191
192
193
194
195
196
197
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
234
235
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 142

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'aggregatedTaxRate')
    self.aggregated_tax_rate = attributes[:'aggregatedTaxRate']
  end

  if attributes.has_key?(:'amountExcludingTax')
    self.amount_excluding_tax = attributes[:'amountExcludingTax']
  end

  if attributes.has_key?(:'amountIncludingTax')
    self.amount_including_tax = attributes[:'amountIncludingTax']
  end

  if attributes.has_key?(:'attributes')
    if (value = attributes[:'attributes']).is_a?(Hash)
      self.attributes = value
    end
  end

  if attributes.has_key?(:'discountExcludingTax')
    self.discount_excluding_tax = attributes[:'discountExcludingTax']
  end

  if attributes.has_key?(:'discountIncludingTax')
    self.discount_including_tax = attributes[:'discountIncludingTax']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

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

  if attributes.has_key?(:'shippingRequired')
    self.shipping_required = attributes[:'shippingRequired']
  end

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

  if attributes.has_key?(:'taxAmount')
    self.tax_amount = attributes[:'taxAmount']
  end

  if attributes.has_key?(:'taxAmountPerUnit')
    self.tax_amount_per_unit = attributes[:'taxAmountPerUnit']
  end

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'undiscountedAmountExcludingTax')
    self.undiscounted_amount_excluding_tax = attributes[:'undiscountedAmountExcludingTax']
  end

  if attributes.has_key?(:'undiscountedAmountIncludingTax')
    self.undiscounted_amount_including_tax = attributes[:'undiscountedAmountIncludingTax']
  end

  if attributes.has_key?(:'undiscountedUnitPriceExcludingTax')
    self.undiscounted_unit_price_excluding_tax = attributes[:'undiscountedUnitPriceExcludingTax']
  end

  if attributes.has_key?(:'undiscountedUnitPriceIncludingTax')
    self.undiscounted_unit_price_including_tax = attributes[:'undiscountedUnitPriceIncludingTax']
  end

  if attributes.has_key?(:'uniqueId')
    self.unique_id = attributes[:'uniqueId']
  end

  if attributes.has_key?(:'unitPriceExcludingTax')
    self.unit_price_excluding_tax = attributes[:'unitPriceExcludingTax']
  end

  if attributes.has_key?(:'unitPriceIncludingTax')
    self.unit_price_including_tax = attributes[:'unitPriceIncludingTax']
  end
end

Instance Attribute Details

#aggregated_tax_rate ⇒ Object

The aggregated tax rate is the sum of all tax rates of the line item.



24
25
26
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 24

def aggregated_tax_rate
  @aggregated_tax_rate
end

#amount_excluding_tax ⇒ Object

Returns the value of attribute amount_excluding_tax.



27
28
29
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 27

def amount_excluding_tax
  @amount_excluding_tax
end

#amount_including_tax ⇒ Object

Returns the value of attribute amount_including_tax.



30
31
32
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 30

def amount_including_tax
  @amount_including_tax
end

#attributes ⇒ Object

Returns the value of attribute attributes.



33
34
35
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 33

def attributes
  @attributes
end

#discount_excluding_tax ⇒ Object

Returns the value of attribute discount_excluding_tax.



36
37
38
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 36

def discount_excluding_tax
  @discount_excluding_tax
end

#discount_including_tax ⇒ Object

Returns the value of attribute discount_including_tax.



39
40
41
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 39

def discount_including_tax
  @discount_including_tax
end

#name ⇒ Object

Returns the value of attribute name.



42
43
44
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 42

def name
  @name
end

#quantity ⇒ Object

Returns the value of attribute quantity.



45
46
47
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 45

def quantity
  @quantity
end

#shipping_required ⇒ Object

Returns the value of attribute shipping_required.



48
49
50
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 48

def shipping_required
  @shipping_required
end

#sku ⇒ Object

Returns the value of attribute sku.



51
52
53
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 51

def sku
  @sku
end

#tax_amount ⇒ Object

Returns the value of attribute tax_amount.



54
55
56
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 54

def tax_amount
  @tax_amount
end

#tax_amount_per_unit ⇒ Object

Returns the value of attribute tax_amount_per_unit.



57
58
59
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 57

def tax_amount_per_unit
  @tax_amount_per_unit
end

#taxes ⇒ Object

Returns the value of attribute taxes.



60
61
62
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 60

def taxes
  @taxes
end

#type ⇒ Object

Returns the value of attribute type.



63
64
65
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 63

def type
  @type
end

#undiscounted_amount_excluding_tax ⇒ Object

Returns the value of attribute undiscounted_amount_excluding_tax.



66
67
68
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 66

def undiscounted_amount_excluding_tax
  @undiscounted_amount_excluding_tax
end

#undiscounted_amount_including_tax ⇒ Object

Returns the value of attribute undiscounted_amount_including_tax.



69
70
71
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 69

def undiscounted_amount_including_tax
  @undiscounted_amount_including_tax
end

#undiscounted_unit_price_excluding_tax ⇒ Object

Returns the value of attribute undiscounted_unit_price_excluding_tax.



72
73
74
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 72

def undiscounted_unit_price_excluding_tax
  @undiscounted_unit_price_excluding_tax
end

#undiscounted_unit_price_including_tax ⇒ Object

Returns the value of attribute undiscounted_unit_price_including_tax.



75
76
77
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 75

def undiscounted_unit_price_including_tax
  @undiscounted_unit_price_including_tax
end

#unique_id ⇒ Object

The unique id identifies the line item within the set of line items associated with the transaction.



78
79
80
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 78

def unique_id
  @unique_id
end

#unit_price_excluding_tax ⇒ Object

Returns the value of attribute unit_price_excluding_tax.



81
82
83
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 81

def unit_price_excluding_tax
  @unit_price_excluding_tax
end

#unit_price_including_tax ⇒ Object

Returns the value of attribute unit_price_including_tax.



84
85
86
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 84

def unit_price_including_tax
  @unit_price_including_tax
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 87

def self.attribute_map
  {
    :'aggregated_tax_rate' => :'aggregatedTaxRate',
    :'amount_excluding_tax' => :'amountExcludingTax',
    :'amount_including_tax' => :'amountIncludingTax',
    :'attributes' => :'attributes',
    :'discount_excluding_tax' => :'discountExcludingTax',
    :'discount_including_tax' => :'discountIncludingTax',
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'shipping_required' => :'shippingRequired',
    :'sku' => :'sku',
    :'tax_amount' => :'taxAmount',
    :'tax_amount_per_unit' => :'taxAmountPerUnit',
    :'taxes' => :'taxes',
    :'type' => :'type',
    :'undiscounted_amount_excluding_tax' => :'undiscountedAmountExcludingTax',
    :'undiscounted_amount_including_tax' => :'undiscountedAmountIncludingTax',
    :'undiscounted_unit_price_excluding_tax' => :'undiscountedUnitPriceExcludingTax',
    :'undiscounted_unit_price_including_tax' => :'undiscountedUnitPriceIncludingTax',
    :'unique_id' => :'uniqueId',
    :'unit_price_excluding_tax' => :'unitPriceExcludingTax',
    :'unit_price_including_tax' => :'unitPriceIncludingTax'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 114

def self.swagger_types
  {
    :'aggregated_tax_rate' => :'Float',
    :'amount_excluding_tax' => :'Float',
    :'amount_including_tax' => :'Float',
    :'attributes' => :'Hash<String, LineItemAttribute>',
    :'discount_excluding_tax' => :'Float',
    :'discount_including_tax' => :'Float',
    :'name' => :'String',
    :'quantity' => :'Float',
    :'shipping_required' => :'BOOLEAN',
    :'sku' => :'String',
    :'tax_amount' => :'Float',
    :'tax_amount_per_unit' => :'Float',
    :'taxes' => :'Array<Tax>',
    :'type' => :'LineItemType',
    :'undiscounted_amount_excluding_tax' => :'Float',
    :'undiscounted_amount_including_tax' => :'Float',
    :'undiscounted_unit_price_excluding_tax' => :'Float',
    :'undiscounted_unit_price_including_tax' => :'Float',
    :'unique_id' => :'String',
    :'unit_price_excluding_tax' => :'Float',
    :'unit_price_including_tax' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 306

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      aggregated_tax_rate == o.aggregated_tax_rate &&
      amount_excluding_tax == o.amount_excluding_tax &&
      amount_including_tax == o.amount_including_tax &&
      attributes == o.attributes &&
      discount_excluding_tax == o.discount_excluding_tax &&
      discount_including_tax == o.discount_including_tax &&
      name == o.name &&
      quantity == o.quantity &&
      shipping_required == o.shipping_required &&
      sku == o.sku &&
      tax_amount == o.tax_amount &&
      tax_amount_per_unit == o.tax_amount_per_unit &&
      taxes == o.taxes &&
      type == o.type &&
      undiscounted_amount_excluding_tax == o.undiscounted_amount_excluding_tax &&
      undiscounted_amount_including_tax == o.undiscounted_amount_including_tax &&
      undiscounted_unit_price_excluding_tax == o.undiscounted_unit_price_excluding_tax &&
      undiscounted_unit_price_including_tax == o.undiscounted_unit_price_including_tax &&
      unique_id == o.unique_id &&
      unit_price_excluding_tax == o.unit_price_excluding_tax &&
      unit_price_including_tax == o.unit_price_including_tax
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 368

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
    temp_model = Wallee.const_get(type).new
    temp_model.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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 434

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 347

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


334
335
336
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



340
341
342
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 340

def hash
  [aggregated_tax_rate, amount_excluding_tax, amount_including_tax, attributes, discount_excluding_tax, discount_including_tax, name, quantity, shipping_required, sku, tax_amount, tax_amount_per_unit, taxes, type, undiscounted_amount_excluding_tax, undiscounted_amount_including_tax, undiscounted_unit_price_excluding_tax, undiscounted_unit_price_including_tax, unique_id, unit_price_excluding_tax, unit_price_including_tax].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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 239

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

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

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

  if !@unique_id.nil? && @unique_id.to_s.length > 200
    invalid_properties.push('invalid value for "unique_id", the character length must be smaller than or equal to 200.')
  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



414
415
416
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 414

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



420
421
422
423
424
425
426
427
428
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 420

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



408
409
410
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 408

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



262
263
264
265
266
267
268
 
# File 'lib/wallee-ruby-sdk/models/line_item.rb', line 262

def valid?
  return false if !@name.nil? && @name.to_s.length > 150
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@sku.nil? && @sku.to_s.length > 200
  return false if !@unique_id.nil? && @unique_id.to_s.length > 200
  true
end