class CyberSource::Ptsv2paymentsDeviceInformation

Attributes

fingerprint_session_id[RW]

Field that contains the session ID that you send to Decision Manager to obtain the device fingerprint information. The string can contain uppercase and lowercase letters, digits, hyphen (-), and underscore (_). However, do not use the same uppercase and lowercase letters to indicate different session IDs. The session ID must be unique for each merchant ID. You can use any string that you are already generating, such as an order number or web session ID. The session ID must be unique for each page load, regardless of an individual’s web session ID. If a user navigates to a profiled page and is assigned a web session, navigates away from the profiled page, then navigates back to the profiled page, the generated session ID should be different and unique. You may use a web session ID, but it is preferable to use an application GUID (Globally Unique Identifier). This measure ensures that a unique ID is generated every time the page is loaded, even if it is the same user reloading the page.

host_name[RW]

DNS resolved hostname from `ipAddress`.

http_accept_browser_value[RW]

Value of the Accept header sent by the customer’s web browser. Note If the customer’s browser provides a value, you must include it in your request.

http_accept_content[RW]

The exact content of the HTTP accept header.

http_browser_color_depth[RW]

Value represents the bit depth of the color palette for displaying images, in bits per pixel. Example : 24, refer en.wikipedia.org/wiki/Color_depth for more details

http_browser_email[RW]

Email address set in the customer’s browser, which may differ from customer email.

http_browser_java_enabled[RW]

A Boolean value that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property. Possible Values:True/False

http_browser_java_script_enabled[RW]

A Boolean value that represents the ability of the cardholder browser to execute JavaScript. Possible Values:True/False. Note: Merchants should be able to know the values from fingerprint details of cardholder's browser.

http_browser_language[RW]

Value represents the browser language as defined in IETF BCP47. Example:en-US, refer en.wikipedia.org/wiki/IETF_language_tag for more details.

http_browser_screen_height[RW]

Total height of the Cardholder's scree in pixels, example: 864.

http_browser_screen_width[RW]

Total width of the cardholder's screen in pixels. Example: 1536.

http_browser_time_difference[RW]

Time difference between UTC time and the cardholder browser local time, in minutes, Example:300

ip_address[RW]

IP address of the customer. #### Used by **Authorization, Capture, and Credit** Optional field.

raw_data[RW]
use_raw_fingerprint_session_id[RW]

Boolean that indicates whether request contains the device fingerprint information. Values: - `true`: Use raw fingerprintSessionId when looking up device details. - `false` (default): Use merchant id + fingerprintSessionId as the session id for Device detail collection.

user_agent[RW]

Customer’s browser as identified from the HTTP header data. For example, `Mozilla` is the value that identifies the Netscape browser.

user_agent_browser_value[RW]

Value of the User-Agent header sent by the customer’s web browser. Note If the customer’s browser provides a value, you must include it in your request.

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/ptsv2payments_device_information.rb, line 68
def self.attribute_map
  {
    :'host_name' => :'hostName',
    :'ip_address' => :'ipAddress',
    :'user_agent' => :'userAgent',
    :'fingerprint_session_id' => :'fingerprintSessionId',
    :'use_raw_fingerprint_session_id' => :'useRawFingerprintSessionId',
    :'raw_data' => :'rawData',
    :'http_accept_browser_value' => :'httpAcceptBrowserValue',
    :'http_accept_content' => :'httpAcceptContent',
    :'http_browser_email' => :'httpBrowserEmail',
    :'http_browser_language' => :'httpBrowserLanguage',
    :'http_browser_java_enabled' => :'httpBrowserJavaEnabled',
    :'http_browser_java_script_enabled' => :'httpBrowserJavaScriptEnabled',
    :'http_browser_color_depth' => :'httpBrowserColorDepth',
    :'http_browser_screen_height' => :'httpBrowserScreenHeight',
    :'http_browser_screen_width' => :'httpBrowserScreenWidth',
    :'http_browser_time_difference' => :'httpBrowserTimeDifference',
    :'user_agent_browser_value' => :'userAgentBrowserValue'
  }
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/ptsv2payments_device_information.rb, line 115
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?(:'hostName')
    self.host_name = attributes[:'hostName']
  end

  if attributes.has_key?(:'ipAddress')
    self.ip_address = attributes[:'ipAddress']
  end

  if attributes.has_key?(:'userAgent')
    self.user_agent = attributes[:'userAgent']
  end

  if attributes.has_key?(:'fingerprintSessionId')
    self.fingerprint_session_id = attributes[:'fingerprintSessionId']
  end

  if attributes.has_key?(:'useRawFingerprintSessionId')
    self.use_raw_fingerprint_session_id = attributes[:'useRawFingerprintSessionId']
  end

  if attributes.has_key?(:'rawData')
    if (value = attributes[:'rawData']).is_a?(Array)
      self.raw_data = value
    end
  end

  if attributes.has_key?(:'httpAcceptBrowserValue')
    self.http_accept_browser_value = attributes[:'httpAcceptBrowserValue']
  end

  if attributes.has_key?(:'httpAcceptContent')
    self.http_accept_content = attributes[:'httpAcceptContent']
  end

  if attributes.has_key?(:'httpBrowserEmail')
    self.http_browser_email = attributes[:'httpBrowserEmail']
  end

  if attributes.has_key?(:'httpBrowserLanguage')
    self.http_browser_language = attributes[:'httpBrowserLanguage']
  end

  if attributes.has_key?(:'httpBrowserJavaEnabled')
    self.http_browser_java_enabled = attributes[:'httpBrowserJavaEnabled']
  end

  if attributes.has_key?(:'httpBrowserJavaScriptEnabled')
    self.http_browser_java_script_enabled = attributes[:'httpBrowserJavaScriptEnabled']
  end

  if attributes.has_key?(:'httpBrowserColorDepth')
    self.http_browser_color_depth = attributes[:'httpBrowserColorDepth']
  end

  if attributes.has_key?(:'httpBrowserScreenHeight')
    self.http_browser_screen_height = attributes[:'httpBrowserScreenHeight']
  end

  if attributes.has_key?(:'httpBrowserScreenWidth')
    self.http_browser_screen_width = attributes[:'httpBrowserScreenWidth']
  end

  if attributes.has_key?(:'httpBrowserTimeDifference')
    self.http_browser_time_difference = attributes[:'httpBrowserTimeDifference']
  end

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

Attribute type mapping.

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 91
def self.swagger_types
  {
    :'host_name' => :'String',
    :'ip_address' => :'String',
    :'user_agent' => :'String',
    :'fingerprint_session_id' => :'String',
    :'use_raw_fingerprint_session_id' => :'BOOLEAN',
    :'raw_data' => :'Array<Ptsv2paymentsDeviceInformationRawData>',
    :'http_accept_browser_value' => :'String',
    :'http_accept_content' => :'String',
    :'http_browser_email' => :'String',
    :'http_browser_language' => :'String',
    :'http_browser_java_enabled' => :'BOOLEAN',
    :'http_browser_java_script_enabled' => :'BOOLEAN',
    :'http_browser_color_depth' => :'String',
    :'http_browser_screen_height' => :'String',
    :'http_browser_screen_width' => :'String',
    :'http_browser_time_difference' => :'String',
    :'user_agent_browser_value' => :'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/ptsv2payments_device_information.rb, line 273
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      host_name == o.host_name &&
      ip_address == o.ip_address &&
      user_agent == o.user_agent &&
      fingerprint_session_id == o.fingerprint_session_id &&
      use_raw_fingerprint_session_id == o.use_raw_fingerprint_session_id &&
      raw_data == o.raw_data &&
      http_accept_browser_value == o.http_accept_browser_value &&
      http_accept_content == o.http_accept_content &&
      http_browser_email == o.http_browser_email &&
      http_browser_language == o.http_browser_language &&
      http_browser_java_enabled == o.http_browser_java_enabled &&
      http_browser_java_script_enabled == o.http_browser_java_script_enabled &&
      http_browser_color_depth == o.http_browser_color_depth &&
      http_browser_screen_height == o.http_browser_screen_height &&
      http_browser_screen_width == o.http_browser_screen_width &&
      http_browser_time_difference == o.http_browser_time_difference &&
      user_agent_browser_value == o.user_agent_browser_value
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/ptsv2payments_device_information.rb, line 331
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/ptsv2payments_device_information.rb, line 397
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/ptsv2payments_device_information.rb, line 310
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
eql?(o) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 297
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/ptsv2payments_device_information.rb, line 303
def hash
  [host_name, ip_address, user_agent, fingerprint_session_id, use_raw_fingerprint_session_id, raw_data, http_accept_browser_value, http_accept_content, http_browser_email, http_browser_language, http_browser_java_enabled, http_browser_java_script_enabled, http_browser_color_depth, http_browser_screen_height, http_browser_screen_width, http_browser_time_difference, user_agent_browser_value].hash
end
host_name=(host_name) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 207
def host_name=(host_name)
  @host_name = host_name
end
http_accept_browser_value=(http_accept_browser_value) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 225
def http_accept_browser_value=(http_accept_browser_value)
  @http_accept_browser_value = http_accept_browser_value
end
http_accept_content=(http_accept_content) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 231
def http_accept_content=(http_accept_content)
  @http_accept_content = http_accept_content
end
http_browser_color_depth=(http_browser_color_depth) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 243
def http_browser_color_depth=(http_browser_color_depth)
  @http_browser_color_depth = http_browser_color_depth
end
http_browser_language=(http_browser_language) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 237
def http_browser_language=(http_browser_language)
  @http_browser_language = http_browser_language
end
http_browser_screen_height=(http_browser_screen_height) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 249
def http_browser_screen_height=(http_browser_screen_height)
  @http_browser_screen_height = http_browser_screen_height
end
http_browser_screen_width=(http_browser_screen_width) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 255
def http_browser_screen_width=(http_browser_screen_width)
  @http_browser_screen_width = http_browser_screen_width
end
http_browser_time_difference=(http_browser_time_difference) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 261
def http_browser_time_difference=(http_browser_time_difference)
  @http_browser_time_difference = http_browser_time_difference
end
ip_address=(ip_address) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 213
def ip_address=(ip_address)
  @ip_address = ip_address
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/ptsv2payments_device_information.rb, line 194
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/ptsv2payments_device_information.rb, line 377
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/ptsv2payments_device_information.rb, line 383
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/ptsv2payments_device_information.rb, line 371
def to_s
  to_hash.to_s
end
user_agent=(user_agent) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 219
def user_agent=(user_agent)
  @user_agent = user_agent
end
user_agent_browser_value=(user_agent_browser_value) click to toggle source

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

# File lib/cybersource_rest_client/models/ptsv2payments_device_information.rb, line 267
def user_agent_browser_value=(user_agent_browser_value)
  @user_agent_browser_value = user_agent_browser_value
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/ptsv2payments_device_information.rb, line 201
def valid?
  true
end