class SquareConnect::OrderLineItem

Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details.

Attributes

base_price_money[RW]

The base price for a single unit of the line item.

catalog_object_id[RW]

The [CatalogItemVariation](type-catalogitemvariation) id applied to this line item.

discounts[RW]

A list of discounts applied to this line item. On read or retrieve, this list includes both item-level discounts and any order-level discounts apportioned to this item. When creating an Order, set your item-level discounts in this list.

gross_sales_money[RW]

The amount of money made in gross sales for this line item. Calculated as the sum of the variation's total price and each modifier's total price. This field is read-only.

modifiers[RW]

The [CatalogModifier](type-catalogmodifier)s applied to this line item.

name[RW]

The name of the line item.

note[RW]

The note of the line item.

quantity[RW]

The quantity purchased, formatted as a decimal number. For example: `"3"`. Line items with a `quantity_unit` can have non-integer quantities. For example: `"1.70000"`.

quantity_unit[RW]

The unit and precision that this line item's quantity is measured in.

taxes[RW]

A list of taxes applied to this line item. On read or retrieve, this list includes both item-level taxes and any order-level taxes apportioned to this item. When creating an Order, set your item-level taxes in this list.

total_discount_money[RW]

The total discount amount of money to collect for the line item. This field is read-only.

total_money[RW]

The total amount of money to collect for this line item. This field is read-only.

total_tax_money[RW]

The total tax amount of money to collect for the line item. This field is read-only.

uid[RW]

Unique ID that identifies the line item only within this order. This field is read-only.

variation_name[RW]

The name of the variation applied to this line item.

variation_total_price_money[RW]

The total price of all item variations sold in this line item. Calculated as `base_price_money` multiplied by `quantity`. Does not include modifiers.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 65
def self.attribute_map
  {
    :'uid' => :'uid',
    :'name' => :'name',
    :'quantity' => :'quantity',
    :'quantity_unit' => :'quantity_unit',
    :'note' => :'note',
    :'catalog_object_id' => :'catalog_object_id',
    :'variation_name' => :'variation_name',
    :'modifiers' => :'modifiers',
    :'taxes' => :'taxes',
    :'discounts' => :'discounts',
    :'base_price_money' => :'base_price_money',
    :'variation_total_price_money' => :'variation_total_price_money',
    :'gross_sales_money' => :'gross_sales_money',
    :'total_tax_money' => :'total_tax_money',
    :'total_discount_money' => :'total_discount_money',
    :'total_money' => :'total_money'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 110
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?(:'uid')
    self.uid = attributes[:'uid']
  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?(:'quantity_unit')
    self.quantity_unit = attributes[:'quantity_unit']
  end

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

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/order_line_item.rb, line 87
def self.swagger_types
  {
    :'uid' => :'String',
    :'name' => :'String',
    :'quantity' => :'String',
    :'quantity_unit' => :'OrderQuantityUnit',
    :'note' => :'String',
    :'catalog_object_id' => :'String',
    :'variation_name' => :'String',
    :'modifiers' => :'Array<OrderLineItemModifier>',
    :'taxes' => :'Array<OrderLineItemTax>',
    :'discounts' => :'Array<OrderLineItemDiscount>',
    :'base_price_money' => :'Money',
    :'variation_total_price_money' => :'Money',
    :'gross_sales_money' => :'Money',
    :'total_tax_money' => :'Money',
    :'total_discount_money' => :'Money',
    :'total_money' => :'Money'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 316
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      name == o.name &&
      quantity == o.quantity &&
      quantity_unit == o.quantity_unit &&
      note == o.note &&
      catalog_object_id == o.catalog_object_id &&
      variation_name == o.variation_name &&
      modifiers == o.modifiers &&
      taxes == o.taxes &&
      discounts == o.discounts &&
      base_price_money == o.base_price_money &&
      variation_total_price_money == o.variation_total_price_money &&
      gross_sales_money == o.gross_sales_money &&
      total_tax_money == o.total_tax_money &&
      total_discount_money == o.total_discount_money &&
      total_money == o.total_money
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/square_connect/models/order_line_item.rb, line 373
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 = SquareConnect.const_get(type).new
    temp_model.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/square_connect/models/order_line_item.rb, line 439
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) 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/square_connect/models/order_line_item.rb, line 352
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 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
catalog_object_id=(catalog_object_id) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 294
def catalog_object_id=(catalog_object_id)

  if !catalog_object_id.nil? && catalog_object_id.to_s.length > 192
    fail ArgumentError, "invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192."
  end

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

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

# File lib/square_connect/models/order_line_item.rb, line 339
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 345
def hash
  [uid, name, quantity, quantity_unit, note, catalog_object_id, variation_name, modifiers, taxes, discounts, base_price_money, variation_total_price_money, gross_sales_money, total_tax_money, total_discount_money, total_money].hash
end
list_invalid_properties() click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 190
def list_invalid_properties
  invalid_properties = Array.new
  if !@uid.nil? && @uid.to_s.length > 60
    invalid_properties.push("invalid value for 'uid', the character length must be smaller than or equal to 60.")
  end

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

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

  if @quantity.to_s.length > 12
    invalid_properties.push("invalid value for 'quantity', the character length must be smaller than or equal to 12.")
  end

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

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

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

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

  return invalid_properties
end
name=(name) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 254
def name=(name)

  if !name.nil? && name.to_s.length > 500
    fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 500."
  end

  @name = name
end
note=(note) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 283
def note=(note)

  if !note.nil? && note.to_s.length > 500
    fail ArgumentError, "invalid value for 'note', the character length must be smaller than or equal to 500."
  end

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

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

# File lib/square_connect/models/order_line_item.rb, line 265
def quantity=(quantity)
  if quantity.nil?
    fail ArgumentError, "quantity cannot be nil"
  end

  if quantity.to_s.length > 12
    fail ArgumentError, "invalid value for 'quantity', the character length must be smaller than or equal to 12."
  end

  if quantity.to_s.length < 1
    fail ArgumentError, "invalid value for 'quantity', the character length must be great 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/square_connect/models/order_line_item.rb, line 419
def to_body
  to_hash
end
to_hash() click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 425
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() click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 413
def to_s
  to_hash.to_s
end
uid=(uid) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 243
def uid=(uid)

  if !uid.nil? && uid.to_s.length > 60
    fail ArgumentError, "invalid value for 'uid', the character length must be smaller than or equal to 60."
  end

  @uid = uid
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/square_connect/models/order_line_item.rb, line 229
def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return false if !@name.nil? && @name.to_s.length > 500
  return false if @quantity.nil?
  return false if @quantity.to_s.length > 12
  return false if @quantity.to_s.length < 1
  return false if !@note.nil? && @note.to_s.length > 500
  return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
  return false if !@variation_name.nil? && @variation_name.to_s.length > 255
  return true
end
variation_name=(variation_name) click to toggle source

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

# File lib/square_connect/models/order_line_item.rb, line 305
def variation_name=(variation_name)

  if !variation_name.nil? && variation_name.to_s.length > 255
    fail ArgumentError, "invalid value for 'variation_name', the character length must be smaller than or equal to 255."
  end

  @variation_name = variation_name
end