class SquareConnect::CatalogTax
A tax in the Catalog object model.
Attributes
If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](type-catalogitem).
Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](type-taxcalculationphase) for possible values
If `true`, the tax will be shown as enabled in the Square Point of Sale app.
Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](type-taxinclusiontype) for possible values
The tax's name. Searchable. This field has max length of 255 Unicode code points.
The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/catalog_tax.rb, line 35 def self.attribute_map { :'name' => :'name', :'calculation_phase' => :'calculation_phase', :'inclusion_type' => :'inclusion_type', :'percentage' => :'percentage', :'applies_to_custom_amounts' => :'applies_to_custom_amounts', :'enabled' => :'enabled' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/catalog_tax.rb, line 60 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?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'calculation_phase') self.calculation_phase = attributes[:'calculation_phase'] end if attributes.has_key?(:'inclusion_type') self.inclusion_type = attributes[:'inclusion_type'] end if attributes.has_key?(:'percentage') self.percentage = attributes[:'percentage'] end if attributes.has_key?(:'applies_to_custom_amounts') self.applies_to_custom_amounts = attributes[:'applies_to_custom_amounts'] end if attributes.has_key?(:'enabled') self.enabled = attributes[:'enabled'] end end
Attribute type mapping.
# File lib/square_connect/models/catalog_tax.rb, line 47 def self.swagger_types { :'name' => :'String', :'calculation_phase' => :'String', :'inclusion_type' => :'String', :'percentage' => :'String', :'applies_to_custom_amounts' => :'BOOLEAN', :'enabled' => :'BOOLEAN' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/catalog_tax.rb, line 107 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && calculation_phase == o.calculation_phase && inclusion_type == o.inclusion_type && percentage == o.percentage && applies_to_custom_amounts == o.applies_to_custom_amounts && enabled == o.enabled end
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/catalog_tax.rb, line 154 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
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/catalog_tax.rb, line 220 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
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/catalog_tax.rb, line 133 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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/catalog_tax.rb, line 120 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/catalog_tax.rb, line 126 def hash [name, calculation_phase, inclusion_type, percentage, applies_to_custom_amounts, enabled].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/catalog_tax.rb, line 94 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/catalog_tax.rb, line 206 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/catalog_tax.rb, line 194 def to_s to_hash.to_s end
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/catalog_tax.rb, line 101 def valid? return true end