class CloudmersiveValidateApiClient::UserAgentValidateResponse

The result of a User-Agent validation request

Attributes

bot_name[RW]

Optional; name of the robot if the request was from a known robot, otherwise null

bot_url[RW]

Optional; if available, the URL to the robot

browser_engine_name[RW]

Name of the Browser Engine

browser_engine_version[RW]

Version of the Browser Engine

browser_name[RW]

Name of the Browser

browser_version[RW]

Version of the Browser

device_brand_name[RW]

Brand name of the User-Agent

device_model[RW]

Model name or number of the User-Agent

device_type[RW]

Device type of the User-Agent; possible values are "DESKTOP", "SMARTPHONE", "TABLET"

is_bot[RW]

True if the request is a known robot, false otherwise

operating_system[RW]

Operating System of the User-Agent (e.g. Windows)

operating_system_cpu_platform[RW]

The CPU platform of the User-Agent (e.g. x64)

operating_system_version[RW]

The version of the operating system of the User-Agent (e.g. "10" for Windows 10)

successful[RW]

True if the operation was successful, false otherwise

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/user_agent_validate_response.rb, line 61
def self.attribute_map
  {
    :'successful' => :'Successful',
    :'is_bot' => :'IsBot',
    :'bot_name' => :'BotName',
    :'bot_url' => :'BotURL',
    :'operating_system' => :'OperatingSystem',
    :'operating_system_cpu_platform' => :'OperatingSystemCPUPlatform',
    :'operating_system_version' => :'OperatingSystemVersion',
    :'device_type' => :'DeviceType',
    :'device_brand_name' => :'DeviceBrandName',
    :'device_model' => :'DeviceModel',
    :'browser_name' => :'BrowserName',
    :'browser_version' => :'BrowserVersion',
    :'browser_engine_name' => :'BrowserEngineName',
    :'browser_engine_version' => :'BrowserEngineVersion'
  }
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/user_agent_validate_response.rb, line 102
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?(:'Successful')
    self.successful = attributes[:'Successful']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/cloudmersive-validate-api-client/models/user_agent_validate_response.rb, line 81
def self.swagger_types
  {
    :'successful' => :'BOOLEAN',
    :'is_bot' => :'BOOLEAN',
    :'bot_name' => :'String',
    :'bot_url' => :'String',
    :'operating_system' => :'String',
    :'operating_system_cpu_platform' => :'String',
    :'operating_system_version' => :'String',
    :'device_type' => :'String',
    :'device_brand_name' => :'String',
    :'device_model' => :'String',
    :'browser_name' => :'String',
    :'browser_version' => :'String',
    :'browser_engine_name' => :'String',
    :'browser_engine_version' => :'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/user_agent_validate_response.rb, line 180
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      successful == o.successful &&
      is_bot == o.is_bot &&
      bot_name == o.bot_name &&
      bot_url == o.bot_url &&
      operating_system == o.operating_system &&
      operating_system_cpu_platform == o.operating_system_cpu_platform &&
      operating_system_version == o.operating_system_version &&
      device_type == o.device_type &&
      device_brand_name == o.device_brand_name &&
      device_model == o.device_model &&
      browser_name == o.browser_name &&
      browser_version == o.browser_version &&
      browser_engine_name == o.browser_engine_name &&
      browser_engine_version == o.browser_engine_version
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/user_agent_validate_response.rb, line 235
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/user_agent_validate_response.rb, line 301
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/user_agent_validate_response.rb, line 214
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/user_agent_validate_response.rb, line 201
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/user_agent_validate_response.rb, line 207
def hash
  [successful, is_bot, bot_name, bot_url, operating_system, operating_system_cpu_platform, operating_system_version, device_type, device_brand_name, device_model, browser_name, browser_version, browser_engine_name, browser_engine_version].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/user_agent_validate_response.rb, line 167
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/user_agent_validate_response.rb, line 281
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/user_agent_validate_response.rb, line 287
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/user_agent_validate_response.rb, line 275
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/user_agent_validate_response.rb, line 174
def valid?
  true
end