Class: CyberSource::Ptsv2paymentsDeviceInformation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Ptsv2paymentsDeviceInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 161

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

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

  if attributes.has_key?(:'appUrl')
    self.app_url = attributes[:'appUrl']
  end

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  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

Instance Attribute Details

#app_url ⇒ Object

This field will contain the deep link that would help the Customer App to wake up.



38
39
40
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 38

def app_url
  @app_url
end

#device_type ⇒ Object

The device type at the client side.



35
36
37
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 35

def device_type
  @device_type
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.



29
30
31
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 29

def fingerprint_session_id
  @fingerprint_session_id
end

#host_name ⇒ Object

DNS resolved hostname from ‘ipAddress`.



20
21
22
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 20

def host_name
  @host_name
end

#http_accept_browser_value ⇒ Object

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.



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

def http_accept_browser_value
  @http_accept_browser_value
end

#http_accept_content ⇒ Object

The exact content of the HTTP accept header.



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

def http_accept_content
  @http_accept_content
end

#http_browser_color_depth ⇒ Object

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



64
65
66
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 64

def http_browser_color_depth
  @http_browser_color_depth
end

#http_browser_email ⇒ Object

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



52
53
54
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 52

def http_browser_email
  @http_browser_email
end

#http_browser_java_enabled ⇒ Object

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



58
59
60
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 58

def http_browser_java_enabled
  @http_browser_java_enabled
end

#http_browser_java_script_enabled ⇒ Object

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.



61
62
63
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 61

def http_browser_java_script_enabled
  @http_browser_java_script_enabled
end

#http_browser_language ⇒ Object

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



55
56
57
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 55

def http_browser_language
  @http_browser_language
end

#http_browser_screen_height ⇒ Object

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



67
68
69
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 67

def http_browser_screen_height
  @http_browser_screen_height
end

#http_browser_screen_width ⇒ Object

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



70
71
72
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 70

def http_browser_screen_width
  @http_browser_screen_width
end

#http_browser_time_difference ⇒ Object

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



73
74
75
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 73

def http_browser_time_difference
  @http_browser_time_difference
end

#id ⇒ Object

Value created by the client software that uniquely identifies the POS device. CyberSource does not forward this value to the processor. Instead, the value is forwarded to the CyberSource reporting functionality. This field is supported only for authorizations and credits on these processors: - American Express Direct - Credit Mutuel-CIC - FDC Nashville Global - OmniPay Direct - SIX Optional field. String (32)



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

def id
  @id
end

#ip_address ⇒ Object

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



23
24
25
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 23

def ip_address
  @ip_address
end

#metadata ⇒ Object

Verifies that the payment is originating from a valid, user-approved application and device. Sending this field helps reduce fraud and declined transactions. Note The length is set for a hexadecimal representation of the GUID/UUID. This field accepts a 36-character string (with hyphens) or a 32-character string (without hyphens). Example 123e4567-e89b-12d3-a456-426655440000 Example 123e4567e89b12d3a456426655440000



41
42
43
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 41

def metadata
  @metadata
end

#raw_data ⇒ Object

Returns the value of attribute raw_data.



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

def raw_data
  @raw_data
end

#use_raw_fingerprint_session_id ⇒ Object

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.



32
33
34
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 32

def use_raw_fingerprint_session_id
  @use_raw_fingerprint_session_id
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.



26
27
28
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 26

def user_agent
  @user_agent
end

#user_agent_browser_value ⇒ Object

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.



76
77
78
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 76

def user_agent_browser_value
  @user_agent_browser_value
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 79

def self.attribute_map
  {
    :'id' => :'id',
    :'host_name' => :'hostName',
    :'ip_address' => :'ipAddress',
    :'user_agent' => :'userAgent',
    :'fingerprint_session_id' => :'fingerprintSessionId',
    :'use_raw_fingerprint_session_id' => :'useRawFingerprintSessionId',
    :'device_type' => :'deviceType',
    :'app_url' => :'appUrl',
    :'metadata' => :'metadata',
    :'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

.json_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 106

def self.json_map
  {
    :'id' => :'id',
    :'host_name' => :'host_name',
    :'ip_address' => :'ip_address',
    :'user_agent' => :'user_agent',
    :'fingerprint_session_id' => :'fingerprint_session_id',
    :'use_raw_fingerprint_session_id' => :'use_raw_fingerprint_session_id',
    :'device_type' => :'device_type',
    :'app_url' => :'app_url',
    :'metadata' => :'metadata',
    :'raw_data' => :'raw_data',
    :'http_accept_browser_value' => :'http_accept_browser_value',
    :'http_accept_content' => :'http_accept_content',
    :'http_browser_email' => :'http_browser_email',
    :'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_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 133

def self.swagger_types
  {
    :'id' => :'String',
    :'host_name' => :'String',
    :'ip_address' => :'String',
    :'user_agent' => :'String',
    :'fingerprint_session_id' => :'String',
    :'use_raw_fingerprint_session_id' => :'BOOLEAN',
    :'device_type' => :'String',
    :'app_url' => :'String',
    :'metadata' => :'String',
    :'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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 347

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      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 &&
      device_type == o.device_type &&
      app_url == o.app_url &&
      metadata == o.metadata &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 409

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



475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 475

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



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 388

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


375
376
377
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 375

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



381
382
383
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 381

def hash
  [id, host_name, ip_address, user_agent, fingerprint_session_id, use_raw_fingerprint_session_id, device_type, app_url, metadata, 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

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



256
257
258
259
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 256

def list_invalid_properties
  invalid_properties = Array.new
  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



455
456
457
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 455

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



461
462
463
464
465
466
467
468
469
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 461

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



449
450
451
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 449

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



263
264
265
 
# File 'lib/cybersource_rest_client/models/ptsv2payments_device_information.rb', line 263

def valid?
  true
end