Class: CyberSource::Riskv1decisionsDeviceInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Riskv1decisionsDeviceInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 66

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?(:'cookiesAccepted')
    self.cookies_accepted = attributes[:'cookiesAccepted']
  end

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

  if attributes.has_key?(:'networkIpAddress')
    self.network_ip_address = attributes[:'networkIpAddress']
  end

  if attributes.has_key?(:'hostName')
    self.host_name = attributes[:'hostName']
  end

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

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

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

Instance Attribute Details

#cookies_accepted ⇒ Object

Whether the customer’s browser accepts cookies. This field can contain one of the following values: - ‘yes`: The customer’s browser accepts cookies. - `no`: The customer’s browser does not accept cookies.



18
19
20
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 18

def cookies_accepted
  @cookies_accepted
end

#fingerprint_session_id ⇒ Object

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.



30
31
32
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 30

def fingerprint_session_id
  @fingerprint_session_id
end

#host_name ⇒ Object

DNS resolved hostname from ‘ipAddress`.



27
28
29
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 27

def host_name
  @host_name
end

#http_browser_email ⇒ Object

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



33
34
35
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 33

def http_browser_email
  @http_browser_email
end

#ip_address ⇒ Object

IP address of the customer.



21
22
23
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 21

def ip_address
  @ip_address
end

#network_ip_address ⇒ Object

Network IP address of the customer (for example, 10.1.27). A network IP address includes up to 256 IP addresses.



24
25
26
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 24

def network_ip_address
  @network_ip_address
end

#user_agent ⇒ Object

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



36
37
38
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 36

def user_agent
  @user_agent
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 39

def self.attribute_map
  {
    :'cookies_accepted' => :'cookiesAccepted',
    :'ip_address' => :'ipAddress',
    :'network_ip_address' => :'networkIpAddress',
    :'host_name' => :'hostName',
    :'fingerprint_session_id' => :'fingerprintSessionId',
    :'http_browser_email' => :'httpBrowserEmail',
    :'user_agent' => :'userAgent'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 52

def self.swagger_types
  {
    :'cookies_accepted' => :'String',
    :'ip_address' => :'String',
    :'network_ip_address' => :'String',
    :'host_name' => :'String',
    :'fingerprint_session_id' => :'String',
    :'http_browser_email' => :'String',
    :'user_agent' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cookies_accepted == o.cookies_accepted &&
      ip_address == o.ip_address &&
      network_ip_address == o.network_ip_address &&
      host_name == o.host_name &&
      fingerprint_session_id == o.fingerprint_session_id &&
      http_browser_email == o.http_browser_email &&
      user_agent == o.user_agent
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 224

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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 290

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 203

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



196
197
198
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 196

def hash
  [cookies_accepted, ip_address, network_ip_address, host_name, fingerprint_session_id, http_browser_email, user_agent].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 103

def list_invalid_properties
  invalid_properties = Array.new
  if !@ip_address.nil? && @ip_address.to_s.length > 48
    invalid_properties.push('invalid value for "ip_address", the character length must be smaller than or equal to 48.')
  end

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 270

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



276
277
278
279
280
281
282
283
284
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 276

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



264
265
266
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 264

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



126
127
128
129
130
131
132
 
# File 'lib/cybersource_rest_client/models/riskv1decisions_device_information.rb', line 126

def valid?
  return false if !@ip_address.nil? && @ip_address.to_s.length > 48
  return false if !@network_ip_address.nil? && @network_ip_address.to_s.length > 11
  return false if !@host_name.nil? && @host_name.to_s.length > 60
  return false if !@user_agent.nil? && @user_agent.to_s.length > 40
  true
end