class SquareConnect::Transaction
Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale. The `tenders` field of this object lists all methods of payment used to pay in the transaction.
Attributes
If the transaction was created in the Square Point of Sale app, this value is the ID generated for the transaction by Square Point of Sale. This ID has no relationship to the transaction's canonical `id`, which is generated by Square's backend servers. This value is generated for bookkeeping purposes, in case the transaction cannot immediately be completed (for example, if the transaction is processed in offline mode). It is not currently possible with the Connect API to perform a transaction lookup by this value.
The time when the transaction was created, in RFC 3339 format.
The transaction's unique ID, issued by Square payments servers.
The ID of the transaction's associated location.
The order_id
is an identifier for the order associated with this transaction, if any.
The Square product that processed the transaction. See [TransactionProduct](type-transactionproduct) for possible values
If the transaction was created with the [Charge](endpoint-transactions-charge) endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set.
Refunds that have been applied to any tender in the transaction.
The shipping address provided in the request, if any.
The tenders used to pay in the transaction.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/transaction.rb, line 47 def self.attribute_map { :'id' => :'id', :'location_id' => :'location_id', :'created_at' => :'created_at', :'tenders' => :'tenders', :'refunds' => :'refunds', :'reference_id' => :'reference_id', :'product' => :'product', :'client_id' => :'client_id', :'shipping_address' => :'shipping_address', :'order_id' => :'order_id' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/transaction.rb, line 80 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?(:'created_at') self.created_at = attributes[:'created_at'] end if attributes.has_key?(:'tenders') if (value = attributes[:'tenders']).is_a?(Array) self.tenders = value end end if attributes.has_key?(:'refunds') if (value = attributes[:'refunds']).is_a?(Array) self.refunds = value end end if attributes.has_key?(:'reference_id') self.reference_id = attributes[:'reference_id'] end if attributes.has_key?(:'product') self.product = attributes[:'product'] end if attributes.has_key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.has_key?(:'shipping_address') self.shipping_address = attributes[:'shipping_address'] end if attributes.has_key?(:'order_id') self.order_id = attributes[:'order_id'] end end
Attribute type mapping.
# File lib/square_connect/models/transaction.rb, line 63 def self.swagger_types { :'id' => :'String', :'location_id' => :'String', :'created_at' => :'String', :'tenders' => :'Array<Tender>', :'refunds' => :'Array<Refund>', :'reference_id' => :'String', :'product' => :'String', :'client_id' => :'String', :'shipping_address' => :'Address', :'order_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/transaction.rb, line 147 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && location_id == o.location_id && created_at == o.created_at && tenders == o.tenders && refunds == o.refunds && reference_id == o.reference_id && product == o.product && client_id == o.client_id && shipping_address == o.shipping_address && order_id == o.order_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/transaction.rb, line 198 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/transaction.rb, line 264 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/transaction.rb, line 177 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/transaction.rb, line 164 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/transaction.rb, line 170 def hash [id, location_id, created_at, tenders, refunds, reference_id, product, client_id, shipping_address, order_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/transaction.rb, line 134 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/transaction.rb, line 250 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/transaction.rb, line 238 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/transaction.rb, line 141 def valid? return true end