Class: CyberSource::Riskv1authenticationsDeviceInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/riskv1authentications_device_information.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1authenticationsDeviceInformation

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 107

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?(:'ipAddress')
    self.ip_address = attributes[:'ipAddress']
  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?(:'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

Instance Attribute Details

#http_accept_browser_valueObject

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.



22
23
24
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 22

def http_accept_browser_value
  @http_accept_browser_value
end

#http_accept_contentObject

The exact content of the HTTP accept header.



25
26
27
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 25

def http_accept_content
  @http_accept_content
end

#http_browser_color_depthObject

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



37
38
39
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 37

def http_browser_color_depth
  @http_browser_color_depth
end

#http_browser_java_enabledObject

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



31
32
33
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 31

def http_browser_java_enabled
  @http_browser_java_enabled
end

#http_browser_java_script_enabledObject

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.



34
35
36
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 34

def http_browser_java_script_enabled
  @http_browser_java_script_enabled
end

#http_browser_languageObject

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



28
29
30
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 28

def http_browser_language
  @http_browser_language
end

#http_browser_screen_heightObject

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



40
41
42
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 40

def http_browser_screen_height
  @http_browser_screen_height
end

#http_browser_screen_widthObject

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



43
44
45
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 43

def http_browser_screen_width
  @http_browser_screen_width
end

#http_browser_time_differenceObject

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



46
47
48
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 46

def http_browser_time_difference
  @http_browser_time_difference
end

#ip_addressObject

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



17
18
19
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 17

def ip_address
  @ip_address
end

#raw_dataObject

Returns the value of attribute raw_data.



19
20
21
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 19

def raw_data
  @raw_data
end

#user_agent_browser_valueObject

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.



49
50
51
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 49

def user_agent_browser_value
  @user_agent_browser_value
end

Class Method Details

.attribute_mapObject

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 52

def self.attribute_map
  {
    :'ip_address' => :'ipAddress',
    :'raw_data' => :'rawData',
    :'http_accept_browser_value' => :'httpAcceptBrowserValue',
    :'http_accept_content' => :'httpAcceptContent',
    :'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

.json_mapObject

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 70

def self.json_map
  {
    :'ip_address' => :'ip_address',
    :'raw_data' => :'raw_data',
    :'http_accept_browser_value' => :'http_accept_browser_value',
    :'http_accept_content' => :'http_accept_content',
    :'http_browser_language' => :'http_browser_language',
    :'http_browser_java_enabled' => :'http_browser_java_enabled',
    :'http_browser_java_script_enabled' => :'http_browser_java_script_enabled',
    :'http_browser_color_depth' => :'http_browser_color_depth',
    :'http_browser_screen_height' => :'http_browser_screen_height',
    :'http_browser_screen_width' => :'http_browser_screen_width',
    :'http_browser_time_difference' => :'http_browser_time_difference',
    :'user_agent_browser_value' => :'user_agent_browser_value'
  }
end

.swagger_typesObject

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 88

def self.swagger_types
  {
    :'ip_address' => :'String',
    :'raw_data' => :'Array<Ptsv2paymentsDeviceInformationRawData>',
    :'http_accept_browser_value' => :'String',
    :'http_accept_content' => :'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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ip_address == o.ip_address &&
      raw_data == o.raw_data &&
      http_accept_browser_value == o.http_accept_browser_value &&
      http_accept_content == o.http_accept_content &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 286

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) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash



352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 352

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 265

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("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[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) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


252
253
254
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 252

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



258
259
260
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 258

def hash
  [ip_address, raw_data, http_accept_browser_value, http_accept_content, 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

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



166
167
168
169
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 166

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



332
333
334
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 332

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



338
339
340
341
342
343
344
345
346
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 338

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



326
327
328
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 326

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid



173
174
175
# File 'lib/cybersource_rest_client/models/riskv1authentications_device_information.rb', line 173

def valid?
  true
end