class Conekta::TransactionResponse
The Transaction object represents the actions or steps of an order. Statuses can be: unprocessed, pending, available, owen, paid_out, voided, capture, capture_reversal, liquidation, liquidation_reversal, payout, payout_reversal, refund, refund_reversal, chargeback, chargeback_reversal, rounding_adjustment, won_chargeback, transferred, and transferred.
Attributes
The amount of the transaction.
Randomly assigned unique order identifier associated with the charge.
Date and time of creation of the transaction in Unix format.
The currency of the transaction. It uses the 3-letter code of the [International Standard ISO 4217.](es.wikipedia.org/wiki/ISO_4217)
The amount to be deducted for taxes and commissions.
Unique identifier of the transaction.
Indicates whether the transaction was created in live mode or test mode.
The net amount after deducting commissions and taxes.
Object name, which is transaction.
Code indicating transaction status.
Transaction Type
Public Class Methods
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/conekta/models/transaction_response.rb, line 325 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Conekta.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Returns all the JSON keys this model knows about
# File lib/conekta/models/transaction_response.rb, line 70 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/conekta/models/transaction_response.rb, line 53 def self.attribute_map { :'amount' => :'amount', :'charge' => :'charge', :'created_at' => :'created_at', :'currency' => :'currency', :'fee' => :'fee', :'id' => :'id', :'livemode' => :'livemode', :'net' => :'net', :'object' => :'object', :'status' => :'status', :'type' => :'type' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/conekta/models/transaction_response.rb, line 301 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/conekta/models/transaction_response.rb, line 99 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Conekta::TransactionResponse` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Conekta::TransactionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'amount') self.amount = attributes[:'amount'] else self.amount = nil end if attributes.key?(:'charge') self.charge = attributes[:'charge'] else self.charge = nil end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] else self.created_at = nil end if attributes.key?(:'currency') self.currency = attributes[:'currency'] else self.currency = nil end if attributes.key?(:'fee') self.fee = attributes[:'fee'] else self.fee = nil end if attributes.key?(:'id') self.id = attributes[:'id'] else self.id = nil end if attributes.key?(:'livemode') self.livemode = attributes[:'livemode'] else self.livemode = nil end if attributes.key?(:'net') self.net = attributes[:'net'] else self.net = nil end if attributes.key?(:'object') self.object = attributes[:'object'] else self.object = nil end if attributes.key?(:'status') self.status = attributes[:'status'] else self.status = nil end if attributes.key?(:'type') self.type = attributes[:'type'] else self.type = nil end end
List of attributes with nullable: true
# File lib/conekta/models/transaction_response.rb, line 92 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/conekta/models/transaction_response.rb, line 75 def self.openapi_types { :'amount' => :'Integer', :'charge' => :'String', :'created_at' => :'Integer', :'currency' => :'String', :'fee' => :'Integer', :'id' => :'String', :'livemode' => :'Boolean', :'net' => :'Integer', :'object' => :'String', :'status' => :'String', :'type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/conekta/models/transaction_response.rb, line 270 def ==(o) return true if self.equal?(o) self.class == o.class && amount == o.amount && charge == o.charge && created_at == o.created_at && currency == o.currency && fee == o.fee && id == o.id && livemode == o.livemode && net == o.net && object == o.object && status == o.status && type == o.type 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/conekta/models/transaction_response.rb, line 396 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
Custom attribute writer method with validation @param [Object] currency Value to be assigned
# File lib/conekta/models/transaction_response.rb, line 256 def currency=(currency) if currency.nil? fail ArgumentError, 'currency cannot be nil' end if currency.to_s.length > 3 fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.' end @currency = currency end
@see the ‘==` method @param [Object] Object to be compared
# File lib/conekta/models/transaction_response.rb, line 288 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/conekta/models/transaction_response.rb, line 294 def hash [amount, charge, created_at, currency, fee, id, livemode, net, object, status, type].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/conekta/models/transaction_response.rb, line 181 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @charge.nil? invalid_properties.push('invalid value for "charge", charge cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end if @currency.nil? invalid_properties.push('invalid value for "currency", currency cannot be nil.') end if @currency.to_s.length > 3 invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.') end if @fee.nil? invalid_properties.push('invalid value for "fee", fee cannot be nil.') end if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @livemode.nil? invalid_properties.push('invalid value for "livemode", livemode cannot be nil.') end if @net.nil? invalid_properties.push('invalid value for "net", net cannot be nil.') end if @object.nil? invalid_properties.push('invalid value for "object", object cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @type.nil? invalid_properties.push('invalid value for "type", type cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/conekta/models/transaction_response.rb, line 378 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/conekta/models/transaction_response.rb, line 366 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/conekta/models/transaction_response.rb, line 237 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @amount.nil? return false if @charge.nil? return false if @created_at.nil? return false if @currency.nil? return false if @currency.to_s.length > 3 return false if @fee.nil? return false if @id.nil? return false if @livemode.nil? return false if @net.nil? return false if @object.nil? return false if @status.nil? return false if @type.nil? true end