class UltracartClient::OrderFraudScore

Attributes

anonymous_proxy[RW]

True if the IP address is a known anonymous proxy server

bin_match[RW]

Whether the BIN (first six digits) matched the country

carder_email[RW]

True if the email address belongs to a known credit card fraudster

country_code[RW]

Country code

country_match[RW]

Country code matches BIN country

customer_phone_in_billing_location[RW]

Whether the customer's phone number is located in the area of the billing address

distance_km[RW]

Distance in kilometers between the IP address and the BIN

free_email[RW]

True if the email address is for a free service like gmail.com

high_risk_country[RW]

True if the customer is in a high risk country known for internet fraud

ip_city[RW]

City associated with the IP address

ip_isp[RW]

ISP that owns the IP address

ip_latitude[RW]

Approximate latitude associated with the IP address

ip_longitude[RW]

Approximate longitude associated with the IP address

ip_org[RW]

Organization that owns the IP address

ip_region[RW]

State/region associated with the IP address

proxy_score[RW]

Likelihood of the IP address being a proxy server

score[RW]

Overall score. This is the score that is compared to see if the order is rejected or held for review by the fraud filter rules.

ship_forwarder[RW]

True if the address is a known ship forwarding company

spam_score[RW]

Likelihood of the email address being associated with a spammer

transparent_proxy[RW]

True if the IP address that placed the order is a transparent proxy server

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/order_fraud_score.rb, line 100
def self.attribute_map
  {
    :'anonymous_proxy' => :'anonymous_proxy',
    :'bin_match' => :'bin_match',
    :'carder_email' => :'carder_email',
    :'country_code' => :'country_code',
    :'country_match' => :'country_match',
    :'customer_phone_in_billing_location' => :'customer_phone_in_billing_location',
    :'distance_km' => :'distance_km',
    :'free_email' => :'free_email',
    :'high_risk_country' => :'high_risk_country',
    :'ip_city' => :'ip_city',
    :'ip_isp' => :'ip_isp',
    :'ip_latitude' => :'ip_latitude',
    :'ip_longitude' => :'ip_longitude',
    :'ip_org' => :'ip_org',
    :'ip_region' => :'ip_region',
    :'proxy_score' => :'proxy_score',
    :'score' => :'score',
    :'ship_forwarder' => :'ship_forwarder',
    :'spam_score' => :'spam_score',
    :'transparent_proxy' => :'transparent_proxy'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/order_fraud_score.rb, line 153
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?(:'anonymous_proxy')
    self.anonymous_proxy = attributes[:'anonymous_proxy']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'transparent_proxy')
    self.transparent_proxy = attributes[:'transparent_proxy']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/order_fraud_score.rb, line 126
def self.swagger_types
  {
    :'anonymous_proxy' => :'BOOLEAN',
    :'bin_match' => :'String',
    :'carder_email' => :'BOOLEAN',
    :'country_code' => :'String',
    :'country_match' => :'BOOLEAN',
    :'customer_phone_in_billing_location' => :'String',
    :'distance_km' => :'Integer',
    :'free_email' => :'BOOLEAN',
    :'high_risk_country' => :'BOOLEAN',
    :'ip_city' => :'String',
    :'ip_isp' => :'String',
    :'ip_latitude' => :'String',
    :'ip_longitude' => :'String',
    :'ip_org' => :'String',
    :'ip_region' => :'String',
    :'proxy_score' => :'Float',
    :'score' => :'Float',
    :'ship_forwarder' => :'BOOLEAN',
    :'spam_score' => :'Float',
    :'transparent_proxy' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ultracart_api/models/order_fraud_score.rb, line 267
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      anonymous_proxy == o.anonymous_proxy &&
      bin_match == o.bin_match &&
      carder_email == o.carder_email &&
      country_code == o.country_code &&
      country_match == o.country_match &&
      customer_phone_in_billing_location == o.customer_phone_in_billing_location &&
      distance_km == o.distance_km &&
      free_email == o.free_email &&
      high_risk_country == o.high_risk_country &&
      ip_city == o.ip_city &&
      ip_isp == o.ip_isp &&
      ip_latitude == o.ip_latitude &&
      ip_longitude == o.ip_longitude &&
      ip_org == o.ip_org &&
      ip_region == o.ip_region &&
      proxy_score == o.proxy_score &&
      score == o.score &&
      ship_forwarder == o.ship_forwarder &&
      spam_score == o.spam_score &&
      transparent_proxy == o.transparent_proxy
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/ultracart_api/models/order_fraud_score.rb, line 328
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 = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/ultracart_api/models/order_fraud_score.rb, line 394
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
bin_match=(bin_match) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] bin_match Object to be assigned

# File lib/ultracart_api/models/order_fraud_score.rb, line 257
def bin_match=(bin_match)
  validator = EnumAttributeValidator.new('String', ['NA', 'No', 'NotFound', 'Yes'])
  unless validator.valid?(bin_match)
    fail ArgumentError, 'invalid value for "bin_match", must be one of #{validator.allowable_values}.'
  end
  @bin_match = bin_match
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/ultracart_api/models/order_fraud_score.rb, line 307
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 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/order_fraud_score.rb, line 294
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ultracart_api/models/order_fraud_score.rb, line 300
def hash
  [anonymous_proxy, bin_match, carder_email, country_code, country_match, customer_phone_in_billing_location, distance_km, free_email, high_risk_country, ip_city, ip_isp, ip_latitude, ip_longitude, ip_org, ip_region, proxy_score, score, ship_forwarder, spam_score, transparent_proxy].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ultracart_api/models/order_fraud_score.rb, line 242
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/order_fraud_score.rb, line 374
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/order_fraud_score.rb, line 380
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ultracart_api/models/order_fraud_score.rb, line 368
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/ultracart_api/models/order_fraud_score.rb, line 249
def valid?
  bin_match_validator = EnumAttributeValidator.new('String', ['NA', 'No', 'NotFound', 'Yes'])
  return false unless bin_match_validator.valid?(@bin_match)
  true
end