class CyberSource::PtsV2PaymentsPost201ResponseRiskInformationIpAddress
Contains detailed response information about the customer's IP address.
Attributes
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).
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).
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.
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).
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).
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.
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).
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 159 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
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/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 207 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
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/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 273 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
Custom attribute writer method with validation @param [Object] administrative_area
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 135 def administrative_area=(administrative_area) @administrative_area = administrative_area end
Custom attribute writer method with validation @param [Object] anonymizer_status
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 117 def anonymizer_status=(anonymizer_status) @anonymizer_status = anonymizer_status end
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/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 186 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
Custom attribute writer method with validation @param [Object] carrier Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 147 def carrier=(carrier) @carrier = carrier end
Custom attribute writer method with validation @param [Object] country Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 129 def country=(country) @country = country end
@see the `==` method @param [Object] Object
to be compared
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 173 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 179 def hash [anonymizer_status, locality, country, administrative_area, routing_method, carrier, organization].hash end
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/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 104 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Custom attribute writer method with validation @param [Object] locality Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 123 def locality=(locality) @locality = locality end
Custom attribute writer method with validation @param [Object] organization Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 153 def organization=(organization) @organization = organization end
Custom attribute writer method with validation @param [Object] routing_method
Value to be assigned
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 141 def routing_method=(routing_method) @routing_method = routing_method end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 259 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/cybersource_rest_client/models/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 247 def to_s to_hash.to_s end
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/pts_v2_payments_post201_response_risk_information_ip_address.rb, line 111 def valid? true end