whoisfreaks 0.2.0

data/lib/whoisfreaks/models/domain_reputation_response.rb

@@ -0,0 +1,297 @@
+=begin
+#WhoisFreaks API
+
+#Complete WhoisFreaks API — WHOIS, DNS, SSL, Geolocation, Typosquatting, IP Intelligence, Domain Reputation, and bulk database downloads. ## Authentication All requests require an `apiKey` query parameter. ## Resources - Docs: https://whoisfreaks.com/documentation - Billing: https://billing.whoisfreaks.com - Support: support@whoisfreaks.com 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@whoisfreaks.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module WhoisFreaks
+  class DomainReputationResponse
+    attr_accessor :input
+
+    attr_accessor :assessed_at
+
+    attr_accessor :version
+
+    attr_accessor :processing_time_ms
+
+    attr_accessor :risk_category
+
+    attr_accessor :dga_score
+
+    attr_accessor :trust_signals
+
+    attr_accessor :intelligence
+
+    attr_accessor :evidence_summary
+
+    attr_accessor :errors
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input' => :'input',
+        :'assessed_at' => :'assessed_at',
+        :'version' => :'version',
+        :'processing_time_ms' => :'processing_time_ms',
+        :'risk_category' => :'risk_category',
+        :'dga_score' => :'dga_score',
+        :'trust_signals' => :'trust_signals',
+        :'intelligence' => :'intelligence',
+        :'evidence_summary' => :'evidence_summary',
+        :'errors' => :'errors'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'input' => :'DomainReputationInput',
+        :'assessed_at' => :'Time',
+        :'version' => :'String',
+        :'processing_time_ms' => :'Integer',
+        :'risk_category' => :'DomainReputationRiskCategory',
+        :'dga_score' => :'DomainReputationDgaScore',
+        :'trust_signals' => :'DomainReputationTrustSignals',
+        :'intelligence' => :'DomainReputationIntelligence',
+        :'evidence_summary' => :'DomainReputationEvidenceSummary',
+        :'errors' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WhoisFreaks::DomainReputationResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WhoisFreaks::DomainReputationResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'input')
+        self.input = attributes[:'input']
+      end
+
+      if attributes.key?(:'assessed_at')
+        self.assessed_at = attributes[:'assessed_at']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      end
+
+      if attributes.key?(:'processing_time_ms')
+        self.processing_time_ms = attributes[:'processing_time_ms']
+      end
+
+      if attributes.key?(:'risk_category')
+        self.risk_category = attributes[:'risk_category']
+      end
+
+      if attributes.key?(:'dga_score')
+        self.dga_score = attributes[:'dga_score']
+      end
+
+      if attributes.key?(:'trust_signals')
+        self.trust_signals = attributes[:'trust_signals']
+      end
+
+      if attributes.key?(:'intelligence')
+        self.intelligence = attributes[:'intelligence']
+      end
+
+      if attributes.key?(:'evidence_summary')
+        self.evidence_summary = attributes[:'evidence_summary']
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          input == o.input &&
+          assessed_at == o.assessed_at &&
+          version == o.version &&
+          processing_time_ms == o.processing_time_ms &&
+          risk_category == o.risk_category &&
+          dga_score == o.dga_score &&
+          trust_signals == o.trust_signals &&
+          intelligence == o.intelligence &&
+          evidence_summary == o.evidence_summary &&
+          errors == o.errors
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [input, assessed_at, version, processing_time_ms, risk_category, dga_score, trust_signals, intelligence, evidence_summary, errors].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = WhoisFreaks.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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
+    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
+
+  end
+
+end

data/lib/whoisfreaks/models/domain_reputation_risk_category.rb

@@ -0,0 +1,349 @@
+=begin
+#WhoisFreaks API
+
+#Complete WhoisFreaks API — WHOIS, DNS, SSL, Geolocation, Typosquatting, IP Intelligence, Domain Reputation, and bulk database downloads. ## Authentication All requests require an `apiKey` query parameter. ## Resources - Docs: https://whoisfreaks.com/documentation - Billing: https://billing.whoisfreaks.com - Support: support@whoisfreaks.com 
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@whoisfreaks.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'date'
+require 'time'
+
+module WhoisFreaks
+  class DomainReputationRiskCategory
+    attr_accessor :verdict
+
+    attr_accessor :confidence
+
+    attr_accessor :primary_threat
+
+    attr_accessor :severity
+
+    attr_accessor :threat_types
+
+    attr_accessor :sources
+
+    attr_accessor :pivot_matches
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'verdict' => :'verdict',
+        :'confidence' => :'confidence',
+        :'primary_threat' => :'primary_threat',
+        :'severity' => :'severity',
+        :'threat_types' => :'threat_types',
+        :'sources' => :'sources',
+        :'pivot_matches' => :'pivot_matches'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'verdict' => :'String',
+        :'confidence' => :'Float',
+        :'primary_threat' => :'String',
+        :'severity' => :'String',
+        :'threat_types' => :'Array<String>',
+        :'sources' => :'Array<String>',
+        :'pivot_matches' => :'Array<DomainReputationPivotMatch>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'primary_threat',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WhoisFreaks::DomainReputationRiskCategory` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `WhoisFreaks::DomainReputationRiskCategory`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'verdict')
+        self.verdict = attributes[:'verdict']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'primary_threat')
+        self.primary_threat = attributes[:'primary_threat']
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      end
+
+      if attributes.key?(:'threat_types')
+        if (value = attributes[:'threat_types']).is_a?(Array)
+          self.threat_types = value
+        end
+      end
+
+      if attributes.key?(:'sources')
+        if (value = attributes[:'sources']).is_a?(Array)
+          self.sources = value
+        end
+      end
+
+      if attributes.key?(:'pivot_matches')
+        if (value = attributes[:'pivot_matches']).is_a?(Array)
+          self.pivot_matches = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if !@confidence.nil? && @confidence > 1
+        invalid_properties.push('invalid value for "confidence", must be smaller than or equal to 1.')
+      end
+
+      if !@confidence.nil? && @confidence < 0
+        invalid_properties.push('invalid value for "confidence", must be greater than or equal to 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      verdict_validator = EnumAttributeValidator.new('String', ["safe", "suspicious", "malicious", "unknown"])
+      return false unless verdict_validator.valid?(@verdict)
+      return false if !@confidence.nil? && @confidence > 1
+      return false if !@confidence.nil? && @confidence < 0
+      severity_validator = EnumAttributeValidator.new('String', ["none", "low", "medium", "high", "critical"])
+      return false unless severity_validator.valid?(@severity)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] verdict Object to be assigned
+    def verdict=(verdict)
+      validator = EnumAttributeValidator.new('String', ["safe", "suspicious", "malicious", "unknown"])
+      unless validator.valid?(verdict)
+        fail ArgumentError, "invalid value for \"verdict\", must be one of #{validator.allowable_values}."
+      end
+      @verdict = verdict
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] confidence Value to be assigned
+    def confidence=(confidence)
+      if confidence.nil?
+        fail ArgumentError, 'confidence cannot be nil'
+      end
+
+      if confidence > 1
+        fail ArgumentError, 'invalid value for "confidence", must be smaller than or equal to 1.'
+      end
+
+      if confidence < 0
+        fail ArgumentError, 'invalid value for "confidence", must be greater than or equal to 0.'
+      end
+
+      @confidence = confidence
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] severity Object to be assigned
+    def severity=(severity)
+      validator = EnumAttributeValidator.new('String', ["none", "low", "medium", "high", "critical"])
+      unless validator.valid?(severity)
+        fail ArgumentError, "invalid value for \"severity\", must be one of #{validator.allowable_values}."
+      end
+      @severity = severity
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          verdict == o.verdict &&
+          confidence == o.confidence &&
+          primary_threat == o.primary_threat &&
+          severity == o.severity &&
+          threat_types == o.threat_types &&
+          sources == o.sources &&
+          pivot_matches == o.pivot_matches
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [verdict, confidence, primary_threat, severity, threat_types, sources, pivot_matches].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = WhoisFreaks.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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
+    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
+
+  end
+
+end