class SquareConnect::OrderReturnDiscount

The line item discount being returned.

Attributes

amount_money[RW]

The total monetary amount of the applicable discount. If it is at order level, it is the value of the order level discount. If it is at line item level, it is the value of the line item level discount. The amount_money won't be set for a percentage-based discount.

applied_money[RW]

The amount of discount actually applied to this line item. When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items.

catalog_object_id[RW]

The catalog object id referencing [CatalogDiscount](type-catalogdiscount).

name[RW]

The discount's name.

percentage[RW]

The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount.

scope[RW]

Indicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemDiscountScope](type-orderlineitemdiscountscope) for possible values

source_discount_uid[RW]

`uid` of the Discount from the Order which contains the original application of this discount.

type[RW]

The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](type-orderlineitemdiscounttype) for possible values

uid[RW]

Unique ID that identifies the return discount 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_return_discount.rb, line 44
def self.attribute_map
  {
    :'uid' => :'uid',
    :'source_discount_uid' => :'source_discount_uid',
    :'catalog_object_id' => :'catalog_object_id',
    :'name' => :'name',
    :'type' => :'type',
    :'percentage' => :'percentage',
    :'amount_money' => :'amount_money',
    :'applied_money' => :'applied_money',
    :'scope' => :'scope'
  }
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_return_discount.rb, line 75
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?(:'source_discount_uid')
    self.source_discount_uid = attributes[:'source_discount_uid']
  end

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

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

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  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?(:'scope')
    self.scope = attributes[:'scope']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/square_connect/models/order_return_discount.rb, line 59
def self.swagger_types
  {
    :'uid' => :'String',
    :'source_discount_uid' => :'String',
    :'catalog_object_id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'percentage' => :'String',
    :'amount_money' => :'Money',
    :'applied_money' => :'Money',
    :'scope' => :'String'
  }
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_return_discount.rb, line 214
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      uid == o.uid &&
      source_discount_uid == o.source_discount_uid &&
      catalog_object_id == o.catalog_object_id &&
      name == o.name &&
      type == o.type &&
      percentage == o.percentage &&
      amount_money == o.amount_money &&
      applied_money == o.applied_money &&
      scope == o.scope
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_return_discount.rb, line 264
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_return_discount.rb, line 330
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_return_discount.rb, line 243
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_return_discount.rb, line 181
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_return_discount.rb, line 230
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_return_discount.rb, line 236
def hash
  [uid, source_discount_uid, catalog_object_id, name, type, percentage, amount_money, applied_money, scope].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_return_discount.rb, line 121
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 !@source_discount_uid.nil? && @source_discount_uid.to_s.length > 60
    invalid_properties.push("invalid value for 'source_discount_uid', the character length must be smaller than or equal to 60.")
  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 !@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 !@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_return_discount.rb, line 192
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_return_discount.rb, line 203
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
source_discount_uid=(source_discount_uid) click to toggle source

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

# File lib/square_connect/models/order_return_discount.rb, line 170
def source_discount_uid=(source_discount_uid)

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

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