class CityPayApiClient::AuthReference

Attributes

amount[RW]

The amount of the transaction in decimal currency format.

amount_value[RW]

The amount of the transaction in integer/request format.

atrn[RW]

A reference number provided by the acquiring services.

authcode[RW]

The authorisation code of the transaction returned by the acquirer or card issuer.

batchno[RW]

A batch number which the transaction has been end of day batched towards.

currency[RW]

The currency of the transaction in ISO 4217 code format.

datetime[RW]

The date and time of the transaction.

identifier[RW]

The identifier of the transaction used to process the transaction.

maskedpan[RW]

A masking of the card number which was used to process the tranasction.

merchantid[RW]

The merchant id of the transaction result.

result[RW]

The result of the transaction.

trans_status[RW]

The current status of the transaction through it's lifecycle.

trans_type[RW]

The type of transaction that was processed.

transno[RW]

The transaction number of the transaction.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/citypay_api_client/models/auth_reference.rb, line 59
def self.attribute_map
  {
    :'amount' => :'amount',
    :'amount_value' => :'amount_value',
    :'atrn' => :'atrn',
    :'authcode' => :'authcode',
    :'batchno' => :'batchno',
    :'currency' => :'currency',
    :'datetime' => :'datetime',
    :'identifier' => :'identifier',
    :'maskedpan' => :'maskedpan',
    :'merchantid' => :'merchantid',
    :'result' => :'result',
    :'trans_status' => :'trans_status',
    :'trans_type' => :'trans_type',
    :'transno' => :'transno'
  }
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/citypay_api_client/models/auth_reference.rb, line 288
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

# File lib/citypay_api_client/models/auth_reference.rb, line 106
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::AuthReference` 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 `CityPayApiClient::AuthReference`. 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']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

List of attributes with nullable: true

# File lib/citypay_api_client/models/auth_reference.rb, line 99
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/citypay_api_client/models/auth_reference.rb, line 79
def self.openapi_types
  {
    :'amount' => :'Integer',
    :'amount_value' => :'String',
    :'atrn' => :'String',
    :'authcode' => :'String',
    :'batchno' => :'String',
    :'currency' => :'String',
    :'datetime' => :'DateTime',
    :'identifier' => :'String',
    :'maskedpan' => :'String',
    :'merchantid' => :'Integer',
    :'result' => :'String',
    :'trans_status' => :'String',
    :'trans_type' => :'String',
    :'transno' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/citypay_api_client/models/auth_reference.rb, line 254
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      amount == o.amount &&
      amount_value == o.amount_value &&
      atrn == o.atrn &&
      authcode == o.authcode &&
      batchno == o.batchno &&
      currency == o.currency &&
      datetime == o.datetime &&
      identifier == o.identifier &&
      maskedpan == o.maskedpan &&
      merchantid == o.merchantid &&
      result == o.result &&
      trans_status == o.trans_status &&
      trans_type == o.trans_type &&
      transno == o.transno
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/citypay_api_client/models/auth_reference.rb, line 316
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
    CityPayApiClient.const_get(type).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/citypay_api_client/models/auth_reference.rb, line 385
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) 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/citypay_api_client/models/auth_reference.rb, line 295
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.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[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
currency=(currency) click to toggle source

Custom attribute writer method with validation @param [Object] currency Value to be assigned

# File lib/citypay_api_client/models/auth_reference.rb, line 216
def currency=(currency)
  if !currency.nil? && currency.to_s.length > 3
    fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
  end

  if !currency.nil? && currency.to_s.length < 3
    fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
  end

  @currency = currency
end
eql?(o) click to toggle source

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

# File lib/citypay_api_client/models/auth_reference.rb, line 275
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/citypay_api_client/models/auth_reference.rb, line 281
def hash
  [amount, amount_value, atrn, authcode, batchno, currency, datetime, identifier, maskedpan, merchantid, result, trans_status, trans_type, transno].hash
end
identifier=(identifier) click to toggle source

Custom attribute writer method with validation @param [Object] identifier Value to be assigned

# File lib/citypay_api_client/models/auth_reference.rb, line 230
def identifier=(identifier)
  if !identifier.nil? && identifier.to_s.length > 50
    fail ArgumentError, 'invalid value for "identifier", the character length must be smaller than or equal to 50.'
  end

  if !identifier.nil? && identifier.to_s.length < 4
    fail ArgumentError, 'invalid value for "identifier", the character length must be great than or equal to 4.'
  end

  @identifier = identifier
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

# File lib/citypay_api_client/models/auth_reference.rb, line 178
def list_invalid_properties
  invalid_properties = Array.new
  if !@currency.nil? && @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 !@currency.nil? && @currency.to_s.length < 3
    invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
  end

  if !@identifier.nil? && @identifier.to_s.length > 50
    invalid_properties.push('invalid value for "identifier", the character length must be smaller than or equal to 50.')
  end

  if !@identifier.nil? && @identifier.to_s.length < 4
    invalid_properties.push('invalid value for "identifier", the character length must be great than or equal to 4.')
  end

  if !@trans_type.nil? && @trans_type.to_s.length > 1
    invalid_properties.push('invalid value for "trans_type", the character length must be smaller than or equal to 1.')
  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/citypay_api_client/models/auth_reference.rb, line 361
def to_body
  to_hash
end
to_hash() click to toggle source

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

# File lib/citypay_api_client/models/auth_reference.rb, line 367
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
to_s() click to toggle source

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

# File lib/citypay_api_client/models/auth_reference.rb, line 355
def to_s
  to_hash.to_s
end
trans_type=(trans_type) click to toggle source

Custom attribute writer method with validation @param [Object] trans_type Value to be assigned

# File lib/citypay_api_client/models/auth_reference.rb, line 244
def trans_type=(trans_type)
  if !trans_type.nil? && trans_type.to_s.length > 1
    fail ArgumentError, 'invalid value for "trans_type", the character length must be smaller than or equal to 1.'
  end

  @trans_type = trans_type
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

# File lib/citypay_api_client/models/auth_reference.rb, line 205
def valid?
  return false if !@currency.nil? && @currency.to_s.length > 3
  return false if !@currency.nil? && @currency.to_s.length < 3
  return false if !@identifier.nil? && @identifier.to_s.length > 50
  return false if !@identifier.nil? && @identifier.to_s.length < 4
  return false if !@trans_type.nil? && @trans_type.to_s.length > 1
  true
end