class OpenapiClient::PurchaseCardsLevel3LineItems

Attributes

commodity_code[RW]

The commodity code used to classify the item purchased.

description[RW]

The description.

discount_amount_and_rate[RW]
line_item_total[RW]

Rate amount in 3 decimal 12 bytes total digit.

product_code[RW]

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

quantity[RW]

The quantity.

unit_measure[RW]

The unit of measure.

unit_price[RW]

Rate amount in 3 decimal 12 bytes total digit.

vat_amount_and_rate[RW]

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
commodity_code=(commodity_code) click to toggle source

Custom attribute writer method with validation @param [Object] commodity_code Value to be assigned

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 164
def commodity_code=(commodity_code)
  if !commodity_code.nil? && commodity_code.to_s.length > 4
    fail ArgumentError, 'invalid value for "commodity_code", the character length must be smaller than or equal to 4.'
  end

  @commodity_code = commodity_code
end
description=(description) click to toggle source

Custom attribute writer method with validation @param [Object] description Value to be assigned

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 184
def description=(description)
  if !description.nil? && description.to_s.length > 30
    fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 30.'
  end

  @description = description
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 230
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
product_code=(product_code) click to toggle source

Custom attribute writer method with validation @param [Object] product_code Value to be assigned

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 174
def product_code=(product_code)
  if !product_code.nil? && product_code.to_s.length > 20
    fail ArgumentError, 'invalid value for "product_code", the character length must be smaller than or equal to 20.'
  end

  @product_code = product_code
end
quantity=(quantity) click to toggle source

Custom attribute writer method with validation @param [Object] quantity Value to be assigned

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 194
def quantity=(quantity)
  if !quantity.nil? && quantity < 1
    fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.'
  end

  @quantity = quantity
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# 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([])) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 315
def to_s
  to_hash.to_s
end
unit_measure=(unit_measure) click to toggle source

Custom attribute writer method with validation @param [Object] unit_measure Value to be assigned

# File lib/openapi_client/models/purchase_cards_level3_line_items.rb, line 204
def unit_measure=(unit_measure)
  if !unit_measure.nil? && unit_measure.to_s.length > 3
    fail ArgumentError, 'invalid value for "unit_measure", the character length must be smaller than or equal to 3.'
  end

  @unit_measure = unit_measure
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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