class SquareConnect::OrderServiceCharge

Represents a service charge applied to an order.

Attributes

amount_money[RW]

The amount of a non-percentage based service charge. Exactly one of `percentage` or `amount_money` should be set.

applied_money[RW]

The amount of money applied to the order by the service charge, as calculated by the server. For fixed-amount service charges, `applied_money` is equal to `amount_money`. For percentage-based service charges, `applied_money` is the money calculated using the percentage. The `applied_money` field will include any inclusive tax amounts as well. This field is read-only.

calculation_phase[RW]

The calculation phase at which to apply the service charge. See [OrderServiceChargeCalculationPhase](type-orderservicechargecalculationphase) for possible values

catalog_object_id[RW]

The catalog object ID referencing the service charge [CatalogObject](type-catalogobject).

name[RW]

The name of the service charge.

percentage[RW]

The service charge percentage, as a string representation of a decimal number. For example, `7.25` indicates 7.25% Exactly one of `percentage` or `amount_money` should be set.

taxable[RW]

Indicates whether the service charge can be taxed. If set to `true`, any order-level taxes will automatically apply to this service charge. Note that service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable.

taxes[RW]

Taxes applied to the service charge. By default, order-level taxes apply to service charges calculated in the `SUBTOTAL_PHASE` if `taxable` is set to `true`.

total_money[RW]

The total amount of money to collect for the service charge. Note that `total_money` does not equal `applied_money` plus `total_tax_money` if an inclusive tax is applied to the service charge since the inclusive tax amount will be included in both `applied_money` and `total_tax_money`. This field is read-only.

total_tax_money[RW]

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

uid[RW]

Unique ID that identifies the service charge only within this order. This field is read-only.

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_service_charge.rb, line 50
def self.attribute_map
  {
    :'uid' => :'uid',
    :'name' => :'name',
    :'catalog_object_id' => :'catalog_object_id',
    :'percentage' => :'percentage',
    :'amount_money' => :'amount_money',
    :'applied_money' => :'applied_money',
    :'total_money' => :'total_money',
    :'total_tax_money' => :'total_tax_money',
    :'calculation_phase' => :'calculation_phase',
    :'taxable' => :'taxable',
    :'taxes' => :'taxes'
  }
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_service_charge.rb, line 85
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?(:'catalog_object_id')
    self.catalog_object_id = attributes[:'catalog_object_id']
  end

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/order_service_charge.rb, line 67
def self.swagger_types
  {
    :'uid' => :'String',
    :'name' => :'String',
    :'catalog_object_id' => :'String',
    :'percentage' => :'String',
    :'amount_money' => :'Money',
    :'applied_money' => :'Money',
    :'total_money' => :'Money',
    :'total_tax_money' => :'Money',
    :'calculation_phase' => :'String',
    :'taxable' => :'BOOLEAN',
    :'taxes' => :'Array<OrderLineItemTax>'
  }
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_service_charge.rb, line 218
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      name == o.name &&
      catalog_object_id == o.catalog_object_id &&
      percentage == o.percentage &&
      amount_money == o.amount_money &&
      applied_money == o.applied_money &&
      total_money == o.total_money &&
      total_tax_money == o.total_tax_money &&
      calculation_phase == o.calculation_phase &&
      taxable == o.taxable &&
      taxes == o.taxes
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_service_charge.rb, line 270
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_service_charge.rb, line 336
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_service_charge.rb, line 249
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_service_charge.rb, line 196
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_service_charge.rb, line 236
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_service_charge.rb, line 242
def hash
  [uid, name, catalog_object_id, percentage, amount_money, applied_money, total_money, total_tax_money, calculation_phase, taxable, taxes].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_service_charge.rb, line 141
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 > 255
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.")
  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 !@percentage.nil? && @percentage.to_s.length > 10
    invalid_properties.push("invalid value for 'percentage', the character length must be smaller than or equal to 10.")
  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_service_charge.rb, line 185
def name=(name)

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

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

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

# File lib/square_connect/models/order_service_charge.rb, line 207
def percentage=(percentage)

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

  @percentage = percentage
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_service_charge.rb, line 316
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_service_charge.rb, line 322
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_service_charge.rb, line 310
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_service_charge.rb, line 174
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_service_charge.rb, line 164
def valid?
  return false if !@uid.nil? && @uid.to_s.length > 60
  return false if !@name.nil? && @name.to_s.length > 255
  return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192
  return false if !@percentage.nil? && @percentage.to_s.length > 10
  return true
end