class CloudmersiveValidateApiClient::IPIntelligenceResponse

IP address intelligence result

Attributes

currency_code[RW]

ISO 4217 currency code for the IP address location

currency_name[RW]

Name of the currency in English

is_bot[RW]

True if the IP address is a known bot, otherwise false

is_eu[RW]

True if the IP address is in the European Union, otherwise false

is_threat[RW]

True if the IP address is a known threat IP, otherwise false

is_tor_node[RW]

True if the IP address is a known Tor exit node, otherwise false

location[RW]

Returns the location of the IP address

region_area[RW]

Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania

subregion_area[RW]

Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean,

Public Class Methods

attribute_map() click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 46
def self.attribute_map
  {
    :'is_bot' => :'IsBot',
    :'is_tor_node' => :'IsTorNode',
    :'is_threat' => :'IsThreat',
    :'is_eu' => :'IsEU',
    :'location' => :'Location',
    :'currency_code' => :'CurrencyCode',
    :'currency_name' => :'CurrencyName',
    :'region_area' => :'RegionArea',
    :'subregion_area' => :'SubregionArea'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 77
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?(:'IsBot')
    self.is_bot = attributes[:'IsBot']
  end

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 61
def self.swagger_types
  {
    :'is_bot' => :'BOOLEAN',
    :'is_tor_node' => :'BOOLEAN',
    :'is_threat' => :'BOOLEAN',
    :'is_eu' => :'BOOLEAN',
    :'location' => :'GeolocateResponse',
    :'currency_code' => :'String',
    :'currency_name' => :'String',
    :'region_area' => :'String',
    :'subregion_area' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 135
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      is_bot == o.is_bot &&
      is_tor_node == o.is_tor_node &&
      is_threat == o.is_threat &&
      is_eu == o.is_eu &&
      location == o.location &&
      currency_code == o.currency_code &&
      currency_name == o.currency_name &&
      region_area == o.region_area &&
      subregion_area == o.subregion_area
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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 185
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 = CloudmersiveValidateApiClient.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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 251
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) 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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 164
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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 151
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 157
def hash
  [is_bot, is_tor_node, is_threat, is_eu, location, currency_code, currency_name, region_area, subregion_area].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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 122
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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 231
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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 237
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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 225
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/cloudmersive-validate-api-client/models/ip_intelligence_response.rb, line 129
def valid?
  true
end