class SquareConnect::Tender
Represents a tender (i.e., a method of payment) used in a Square transaction.
Attributes
Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.
The amount of the tender.
The details of the card tender. This value is present only if the value of `type` is `CARD`.
The details of the cash tender. This value is present only if the value of `type` is `CASH`.
The time when the tender was created, in RFC 3339 format.
If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer.
The tender's unique ID.
The ID of the transaction's associated location.
An optional note associated with the tender at the time of payment.
The amount of any Square processing fees applied to the tender. This field is not immediately populated when a new transaction is created. It is usually available after about ten seconds.
The tip's amount of the tender.
The ID of the tender's associated transaction.
The type of tender, such as `CARD` or `CASH`. See [TenderType](type
-tendertype) for possible values
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/tender.rb, line 56 def self.attribute_map { :'id' => :'id', :'location_id' => :'location_id', :'transaction_id' => :'transaction_id', :'created_at' => :'created_at', :'note' => :'note', :'amount_money' => :'amount_money', :'tip_money' => :'tip_money', :'processing_fee_money' => :'processing_fee_money', :'customer_id' => :'customer_id', :'type' => :'type', :'card_details' => :'card_details', :'cash_details' => :'cash_details', :'additional_recipients' => :'additional_recipients' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/tender.rb, line 95 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'location_id') self.location_id = attributes[:'location_id'] end if attributes.has_key?(:'transaction_id') self.transaction_id = attributes[:'transaction_id'] end if attributes.has_key?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'tip_money') self.tip_money = attributes[:'tip_money'] end if attributes.has_key?(:'processing_fee_money') self.processing_fee_money = attributes[:'processing_fee_money'] end if attributes.has_key?(:'customer_id') self.customer_id = attributes[:'customer_id'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'card_details') self.card_details = attributes[:'card_details'] end if attributes.has_key?(:'cash_details') self.cash_details = attributes[:'cash_details'] end if attributes.has_key?(:'additional_recipients') if (value = attributes[:'additional_recipients']).is_a?(Array) self.additional_recipients = value end end end
Attribute type mapping.
# File lib/square_connect/models/tender.rb, line 75 def self.swagger_types { :'id' => :'String', :'location_id' => :'String', :'transaction_id' => :'String', :'created_at' => :'String', :'note' => :'String', :'amount_money' => :'Money', :'tip_money' => :'Money', :'processing_fee_money' => :'Money', :'customer_id' => :'String', :'type' => :'String', :'card_details' => :'TenderCardDetails', :'cash_details' => :'TenderCashDetails', :'additional_recipients' => :'Array<AdditionalRecipient>' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/tender.rb, line 177 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && location_id == o.location_id && transaction_id == o.transaction_id && created_at == o.created_at && note == o.note && amount_money == o.amount_money && tip_money == o.tip_money && processing_fee_money == o.processing_fee_money && customer_id == o.customer_id && type == o.type && card_details == o.card_details && cash_details == o.cash_details && additional_recipients == o.additional_recipients 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/tender.rb, line 231 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/tender.rb, line 297 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/tender.rb, line 210 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/tender.rb, line 197 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/tender.rb, line 203 def hash [id, location_id, transaction_id, created_at, note, amount_money, tip_money, processing_fee_money, customer_id, type, card_details, cash_details, additional_recipients].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/tender.rb, line 159 def list_invalid_properties invalid_properties = Array.new if @type.nil? invalid_properties.push("invalid value for 'type', type cannot be nil.") end 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/tender.rb, line 283 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/tender.rb, line 271 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/tender.rb, line 170 def valid? return false if @type.nil? return true end