Class: CyberSource::PtsV2PaymentsPost201ResponseRiskInformationIpAddress

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

Overview

Contains detailed response information about the customer’s IP address.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PtsV2PaymentsPost201ResponseRiskInformationIpAddress

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
100
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 67

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

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

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

  if attributes.has_key?(:'administrativeArea')
    self.administrative_area = attributes[:'administrativeArea']
  end

  if attributes.has_key?(:'routingMethod')
    self.routing_method = attributes[:'routingMethod']
  end

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

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

Instance Attribute Details

#administrative_area ⇒ Object

Name of the state decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the ‘score_ip_state` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



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

def administrative_area
  @administrative_area
end

#anonymizer_status ⇒ Object

Indicates whether the transaction IP address is associated with a known anonymous proxy. For all possible values, see the ‘score_ip_anonymizer_status` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



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

def anonymizer_status
  @anonymizer_status
end

#carrier ⇒ Object

Provides the name of the organization that owns the ASN. The carrier is responsible for the traffic carried on the network or set of networks designated as an Autonomous System (AS) and identified by the ASN. While there are more than 27,000 active ASNs, there are fewer carriers, because a single carrier often manages several ASNs.



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

def carrier
  @carrier
end

#country ⇒ Object

Name of the country decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the ‘score_ip_country` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



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

def country
  @country
end

#locality ⇒ Object

Name of the city decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the ‘score_ip_city` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



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

def locality
  @locality
end

#organization ⇒ Object

The Registering Organization is the entity responsible for the actions and content associated with a given block of IP addresses. This is in contrast to the carrier, which is responsible for the routing of traffic for network blocks. Registering Organizations include many types of entities, including corporate, government, or educational entities, and ISPs managing the allocation and use of network blocks.



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

def organization
  @organization
end

#routing_method ⇒ Object

Routing method decoded from the IP address used directly or indirectly by the customer to send the order. For all possible values, see the ‘score_ip_routing_method` field description in the _Decision Manager Using the SCMP API Developer Guide_ on the [CyberSource Business Center.](ebc2.cybersource.com/ebc2/) Click **Decision Manager** > Documentation > Guides > _Decision Manager Using the SCMP API Developer Guide_ (PDF link).



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

def routing_method
  @routing_method
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'anonymizer_status' => :'anonymizerStatus',
    :'locality' => :'locality',
    :'country' => :'country',
    :'administrative_area' => :'administrativeArea',
    :'routing_method' => :'routingMethod',
    :'carrier' => :'carrier',
    :'organization' => :'organization'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'anonymizer_status' => :'String',
    :'locality' => :'String',
    :'country' => :'String',
    :'administrative_area' => :'String',
    :'routing_method' => :'String',
    :'carrier' => :'String',
    :'organization' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      anonymizer_status == o.anonymizer_status &&
      locality == o.locality &&
      country == o.country &&
      administrative_area == o.administrative_area &&
      routing_method == o.routing_method &&
      carrier == o.carrier &&
      organization == o.organization
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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 270

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 336

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 249

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


236
237
238
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 236

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



242
243
244
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 242

def hash
  [anonymizer_status, locality, country, administrative_area, routing_method, carrier, organization].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



104
105
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
131
132
133
134
135
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 104

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

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

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

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

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

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

  if !@organization.nil? && @organization.to_s.length > 255
    invalid_properties.push('invalid value for "organization", the character length must be smaller than or equal to 255.')
  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



316
317
318
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 316

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



322
323
324
325
326
327
328
329
330
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 322

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



310
311
312
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 310

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



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb', line 139

def valid?
  return false if !@anonymizer_status.nil? && @anonymizer_status.to_s.length > 255
  return false if !@locality.nil? && @locality.to_s.length > 255
  return false if !@country.nil? && @country.to_s.length > 255
  return false if !@administrative_area.nil? && @administrative_area.to_s.length > 255
  return false if !@routing_method.nil? && @routing_method.to_s.length > 255
  return false if !@carrier.nil? && @carrier.to_s.length > 255
  return false if !@organization.nil? && @organization.to_s.length > 255
  true
end