class CyberSource::TssV2TransactionsGet200ResponseClientReferenceInformation

Attributes

application_name[RW]

The name of the Connection Method client (such as Virtual Terminal or SOAP Toolkit API) that the merchant uses to send a transaction request to CyberSource.

application_user[RW]

The entity that is responsible for running the transaction and submitting the processing request to CyberSource. This could be a person, a system, or a connection method.

application_version[RW]

Version of the CyberSource application or integration used for a transaction.

code[RW]

Merchant-generated order reference or tracking number. It is recommended that you send a unique value for each transaction so that you can perform meaningful searches for the transaction. #### Used by Authorization Required field. #### PIN Debit Requests for PIN debit reversals need to use the same merchant reference number that was used in the transaction that is being reversed. Required field for all PIN Debit requests (purchase, credit, and reversal). #### FDC Nashville Global Certain circumstances can cause the processor to truncate this value to 15 or 17 characters for Level II and Level III processing, which can cause a discrepancy between the value you submit and the value included in some processor reports.

comments[RW]

Brief description of the order or any comment you wish to add to the order.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 33
def self.attribute_map
  {
    :'code' => :'code',
    :'application_version' => :'applicationVersion',
    :'application_name' => :'applicationName',
    :'application_user' => :'applicationUser',
    :'comments' => :'comments'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 56
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?(:'code')
    self.code = attributes[:'code']
  end

  if attributes.has_key?(:'applicationVersion')
    self.application_version = attributes[:'applicationVersion']
  end

  if attributes.has_key?(:'applicationName')
    self.application_name = attributes[:'applicationName']
  end

  if attributes.has_key?(:'applicationUser')
    self.application_user = attributes[:'applicationUser']
  end

  if attributes.has_key?(:'comments')
    self.comments = attributes[:'comments']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 44
def self.swagger_types
  {
    :'code' => :'String',
    :'application_version' => :'String',
    :'application_name' => :'String',
    :'application_user' => :'String',
    :'comments' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 110
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      application_version == o.application_version &&
      application_name == o.application_name &&
      application_user == o.application_user &&
      comments == o.comments
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/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 156
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 = CyberSource.const_get(type).new
    temp_model.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/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 222
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/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 135
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
code=(code) click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 98
def code=(code)
  @code = code
end
comments=(comments) click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 104
def comments=(comments)
  @comments = comments
end
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 122
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 128
def hash
  [code, application_version, application_name, application_user, comments].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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 85
def list_invalid_properties
  invalid_properties = Array.new
  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/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 202
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/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 208
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
to_s() click to toggle source

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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 196
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

# File lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_client_reference_information.rb, line 92
def valid?
  true
end