class SquareConnect::V1PaymentSurcharge
Attributes
The amount of the surcharge as a Money
object. Exactly one of rate or amount_money
should be set.
The amount of money applied to the order as a result of the surcharge.
The name of the surcharge.
The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, "0.7" corresponds to a 7% surcharge. Exactly one of rate or amount_money
should be set.
A Square-issued unique identifier associated with the surcharge.
Indicates whether the surcharge is taxable.
The list of taxes that should be applied to the surcharge.
Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. See [V1PaymentSurchargeType](type
-v1paymentsurchargetype) for possible values
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/v1_payment_surcharge.rb, line 41 def self.attribute_map { :'name' => :'name', :'applied_money' => :'applied_money', :'rate' => :'rate', :'amount_money' => :'amount_money', :'type' => :'type', :'taxable' => :'taxable', :'taxes' => :'taxes', :'surcharge_id' => :'surcharge_id' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/v1_payment_surcharge.rb, line 70 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?(:'applied_money') self.applied_money = attributes[:'applied_money'] end if attributes.has_key?(:'rate') self.rate = attributes[:'rate'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] 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 if attributes.has_key?(:'surcharge_id') self.surcharge_id = attributes[:'surcharge_id'] end end
Attribute type mapping.
# File lib/square_connect/models/v1_payment_surcharge.rb, line 55 def self.swagger_types { :'name' => :'String', :'applied_money' => :'V1Money', :'rate' => :'String', :'amount_money' => :'V1Money', :'type' => :'String', :'taxable' => :'BOOLEAN', :'taxes' => :'Array<V1PaymentTax>', :'surcharge_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/v1_payment_surcharge.rb, line 127 def ==(o) return true if self.equal?(o) self.class == o.class && name == o.name && applied_money == o.applied_money && rate == o.rate && amount_money == o.amount_money && type == o.type && taxable == o.taxable && taxes == o.taxes && surcharge_id == o.surcharge_id 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/v1_payment_surcharge.rb, line 176 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/v1_payment_surcharge.rb, line 242 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/v1_payment_surcharge.rb, line 155 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/v1_payment_surcharge.rb, line 142 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/v1_payment_surcharge.rb, line 148 def hash [name, applied_money, rate, amount_money, type, taxable, taxes, surcharge_id].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/v1_payment_surcharge.rb, line 114 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/v1_payment_surcharge.rb, line 228 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/v1_payment_surcharge.rb, line 216 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/v1_payment_surcharge.rb, line 121 def valid? return true end