Class: OpenapiClient::PurchaseCardsLevel3LineItems

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PurchaseCardsLevel3LineItems

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
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
115
116
117
118
119
120
121
122
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 74

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#commodity_code ⇒ Object

The commodity code used to classify the item purchased.



18
19
20
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 18

def commodity_code
  @commodity_code
end

#description ⇒ Object

The description.



24
25
26
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 24

def description
  @description
end

#discount_amount_and_rate ⇒ Object

Returns the value of attribute discount_amount_and_rate.



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

def discount_amount_and_rate
  @discount_amount_and_rate
end

#line_item_total ⇒ Object

Rate amount in 3 decimal 12 bytes total digit.



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

def line_item_total
  @line_item_total
end

#product_code ⇒ Object

Merchant product identifier/the Universal Product Code (UPC) of the item purchased.



21
22
23
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 21

def product_code
  @product_code
end

#quantity ⇒ Object

The quantity.



27
28
29
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 27

def quantity
  @quantity
end

#unit_measure ⇒ Object

The unit of measure.



30
31
32
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 30

def unit_measure
  @unit_measure
end

#unit_price ⇒ Object

Rate amount in 3 decimal 12 bytes total digit.



33
34
35
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 33

def unit_price
  @unit_price
end

#vat_amount_and_rate ⇒ Object

Returns the value of attribute vat_amount_and_rate.



35
36
37
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 35

def vat_amount_and_rate
  @vat_amount_and_rate
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 43

def self.attribute_map
  {
    :'commodity_code' => :'commodityCode',
    :'product_code' => :'productCode',
    :'description' => :'description',
    :'quantity' => :'quantity',
    :'unit_measure' => :'unitMeasure',
    :'unit_price' => :'unitPrice',
    :'vat_amount_and_rate' => :'vatAmountAndRate',
    :'discount_amount_and_rate' => :'discountAmountAndRate',
    :'line_item_total' => :'lineItemTotal'
  }
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



243
244
245
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 243

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 58

def self.openapi_types
  {
    :'commodity_code' => :'String',
    :'product_code' => :'String',
    :'description' => :'String',
    :'quantity' => :'Integer',
    :'unit_measure' => :'String',
    :'unit_price' => :'Float',
    :'vat_amount_and_rate' => :'AdditionalAmountRate',
    :'discount_amount_and_rate' => :'AdditionalAmountRate',
    :'line_item_total' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 214

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      commodity_code == o.commodity_code &&
      product_code == o.product_code &&
      description == o.description &&
      quantity == o.quantity &&
      unit_measure == o.unit_measure &&
      unit_price == o.unit_price &&
      vat_amount_and_rate == o.vat_amount_and_rate &&
      discount_amount_and_rate == o.discount_amount_and_rate &&
      line_item_total == o.line_item_total
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



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
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 271

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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 345

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, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 250

def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  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[attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[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


230
231
232
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 230

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [commodity_code, product_code, description, quantity, unit_measure, unit_price, vat_amount_and_rate, discount_amount_and_rate, line_item_total].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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 126

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

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

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

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

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



321
322
323
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 321

def to_body
  to_hash
end

#to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 327

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



315
316
317
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 315

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



153
154
155
156
157
158
159
160
 
# File 'lib/openapi_client/models/purchase_cards_level3_line_items.rb', line 153

def valid?
  return false if !@commodity_code.nil? && @commodity_code.to_s.length > 4
  return false if !@product_code.nil? && @product_code.to_s.length > 20
  return false if !@description.nil? && @description.to_s.length > 30
  return false if !@quantity.nil? && @quantity < 1
  return false if !@unit_measure.nil? && @unit_measure.to_s.length > 3
  true
end