class OpenapiClient::ReturnTransaction

Request to perform return transaction.

Attributes

currency_conversion[RW]
soft_descriptor[RW]
stored_credentials[RW]
transaction_amount[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/openapi_client/models/return_transaction.rb, line 27
def self.attribute_map
  {
    :'transaction_amount' => :'transactionAmount',
    :'soft_descriptor' => :'softDescriptor',
    :'stored_credentials' => :'storedCredentials',
    :'currency_conversion' => :'currencyConversion'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/openapi_client/models/return_transaction.rb, line 133
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Calls superclass method
# File lib/openapi_client/models/return_transaction.rb, line 56
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ReturnTransaction` 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 `OpenapiClient::ReturnTransaction`. 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
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'transaction_amount')
    self.transaction_amount = attributes[:'transaction_amount']
  end

  if attributes.key?(:'soft_descriptor')
    self.soft_descriptor = attributes[:'soft_descriptor']
  end

  if attributes.key?(:'stored_credentials')
    self.stored_credentials = attributes[:'stored_credentials']
  end

  if attributes.key?(:'currency_conversion')
    self.currency_conversion = attributes[:'currency_conversion']
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/openapi_client/models/return_transaction.rb, line 47
def self.openapi_all_of
  [
  :'ReturnTransactionAllOf',
  :'SecondaryTransaction'
  ]
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/openapi_client/models/return_transaction.rb, line 37
def self.openapi_types
  {
    :'transaction_amount' => :'Amount',
    :'soft_descriptor' => :'SoftDescriptor',
    :'stored_credentials' => :'StoredCredential',
    :'currency_conversion' => :'CurrencyConversion'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

Calls superclass method
# File lib/openapi_client/models/return_transaction.rb, line 109
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      transaction_amount == o.transaction_amount &&
      soft_descriptor == o.soft_descriptor &&
      stored_credentials == o.stored_credentials &&
      currency_conversion == o.currency_conversion && super(o)
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/openapi_client/models/return_transaction.rb, line 162
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
    klass = OpenapiClient.const_get(type)
    if klass.respond_to?(:openapi_discriminator_name)
      klass = OpenapiClient.const_get(value[klass.attribute_map[klass.openapi_discriminator_name]])
    end
 
    klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/openapi_client/models/return_transaction.rb, line 236
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
build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

Calls superclass method
# File lib/openapi_client/models/return_transaction.rb, line 140
def build_from_hash(attributes, attribute_map = self.class.attribute_map, openapi_types = self.class.openapi_types)
  return nil unless attributes.is_a?(Hash)
  super(attributes, self.class.superclass.attribute_map, self.class.superclass.openapi_types)
  openapi_types.each_pair do |key, type|
    if 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)
        self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/openapi_client/models/return_transaction.rb, line 120
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/openapi_client/models/return_transaction.rb, line 126
def hash
  [transaction_amount, soft_descriptor, stored_credentials, currency_conversion].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Calls superclass method
# File lib/openapi_client/models/return_transaction.rb, line 91
def list_invalid_properties
  invalid_properties = super
  if @transaction_amount.nil?
    invalid_properties.push('invalid value for "transaction_amount", transaction_amount cannot be nil.')
  end

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/openapi_client/models/return_transaction.rb, line 212
def to_body
  to_hash
end
to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([])) click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

Calls superclass method
# File lib/openapi_client/models/return_transaction.rb, line 218
def to_hash(attribute_map = self.class.attribute_map, openapi_nullable = Set.new([]))
  hash = super(self.class.superclass.attribute_map, openapi_nullable)
  attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/openapi_client/models/return_transaction.rb, line 206
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

Calls superclass method
# File lib/openapi_client/models/return_transaction.rb, line 102
def valid?
  return false if @transaction_amount.nil?
  true && super
end