crimson-falcon 1.1.0 → 1.2.0

data/lib/crimson-falcon/models/domain_vulnerability_cvss_v2.rb

@@ -0,0 +1,303 @@
+=begin
+Crimson Falcon - Ruby Client SDK
+
+Code auto-generated by OpenAPI Generator; DO NOT EDIT.
+
+MIT License
+
+Copyright (c) 2023 Crowdstrike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=end
+
+require 'date'
+require 'time'
+
+module Falcon
+  class DomainVulnerabilityCvssV2
+    # Access complexity of the vulnerability, one of: Low, Medium, High
+    attr_accessor :access_complexity
+
+    # Access vector describing how the vulnerability is exploited, one of: Local, Network, AdjacentNetwork
+    attr_accessor :access_vector
+
+    # Represents the number of times an attacker must authenticate to a target in order to exploit a vulnerability, one of: None, Single, Multiple
+    attr_accessor :authentication
+
+    attr_accessor :availability_impact
+
+    attr_accessor :confidentiality_impact
+
+    # Represents the impact to integrity of a successfully exploited vulnerability, one of: None, Partial, Complete
+    attr_accessor :integrity_impact
+
+    # Score of the vulnerability - which is between 0 and 10, the higher is the score - the more riskier the vulnerability is
+    attr_accessor :score
+
+    # Severity of the vulnerability, can be empty or one of: LOW, MEDIUM, HIGH
+    attr_accessor :severity
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'access_complexity' => :'access_complexity',
+        :'access_vector' => :'access_vector',
+        :'authentication' => :'authentication',
+        :'availability_impact' => :'availability_impact',
+        :'confidentiality_impact' => :'confidentiality_impact',
+        :'integrity_impact' => :'integrity_impact',
+        :'score' => :'score',
+        :'severity' => :'severity'
+      }
+    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
+      {
+        :'access_complexity' => :'String',
+        :'access_vector' => :'String',
+        :'authentication' => :'String',
+        :'availability_impact' => :'String',
+        :'confidentiality_impact' => :'String',
+        :'integrity_impact' => :'String',
+        :'score' => :'Float',
+        :'severity' => :'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 `Falcon::DomainVulnerabilityCvssV2` 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 `Falcon::DomainVulnerabilityCvssV2`. 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?(:'access_complexity')
+        self.access_complexity = attributes[:'access_complexity']
+      end
+
+      if attributes.key?(:'access_vector')
+        self.access_vector = attributes[:'access_vector']
+      end
+
+      if attributes.key?(:'authentication')
+        self.authentication = attributes[:'authentication']
+      end
+
+      if attributes.key?(:'availability_impact')
+        self.availability_impact = attributes[:'availability_impact']
+      end
+
+      if attributes.key?(:'confidentiality_impact')
+        self.confidentiality_impact = attributes[:'confidentiality_impact']
+      end
+
+      if attributes.key?(:'integrity_impact')
+        self.integrity_impact = attributes[:'integrity_impact']
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      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
+      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?
+      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 &&
+          access_complexity == o.access_complexity &&
+          access_vector == o.access_vector &&
+          authentication == o.authentication &&
+          availability_impact == o.availability_impact &&
+          confidentiality_impact == o.confidentiality_impact &&
+          integrity_impact == o.integrity_impact &&
+          score == o.score &&
+          severity == o.severity
+    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
+      [access_complexity, access_vector, authentication, availability_impact, confidentiality_impact, integrity_impact, score, severity].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[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
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Falcon.const_get(type)
+        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/crimson-falcon/models/domain_vulnerability_cvss_v3.rb

@@ -0,0 +1,325 @@
+=begin
+Crimson Falcon - Ruby Client SDK
+
+Code auto-generated by OpenAPI Generator; DO NOT EDIT.
+
+MIT License
+
+Copyright (c) 2023 Crowdstrike
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+=end
+
+require 'date'
+require 'time'
+
+module Falcon
+  class DomainVulnerabilityCvssV3
+    # Describes the conditions beyond the attacker’s control that must exist in order to exploit the vulnerability, one of: Low, High
+    attr_accessor :attack_complexity
+
+    # Reflects the context by which vulnerability exploitation is possible, one of: Network, Adjacent, Local, Physical
+    attr_accessor :attack_vector
+
+    # Measures the potential impact to availability of a successfully exploited misuse vulnerability, one of: None, Low, High
+    attr_accessor :availability_impact
+
+    # Measures the potential impact on confidentiality of a successfully exploited misuse vulnerability, one of: None, Low, High
+    attr_accessor :confidentiality_impact
+
+    # Measures the potential impact to integrity of a successfully exploited misuse vulnerability, one of: None, Low, High
+    attr_accessor :integrity_impact
+
+    # Describes the level of privileges an attacker must possess before successfully exploiting the vulnerability, one of: None, Low, High
+    attr_accessor :privileges_required
+
+    # The Scope metric captures whether a vulnerability in one vulnerable component impacts resources in components beyond its security scope, one of: Unchanged, Changed
+    attr_accessor :scope
+
+    # Score of the vulnerability - which is between 0 and 10, the higher is the score - the more riskier the vulnerability is
+    attr_accessor :score
+
+    # Severity of the vulnerability, can be empty or one of: LOW, MEDIUM, HIGH, CRITICAL
+    attr_accessor :severity
+
+    # Captures the requirement for a human user, other than the attacker, to participate in the successful compromise of the vulnerable component, one of: None, Required
+    attr_accessor :user_interaction
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'attack_complexity' => :'attack_complexity',
+        :'attack_vector' => :'attack_vector',
+        :'availability_impact' => :'availability_impact',
+        :'confidentiality_impact' => :'confidentiality_impact',
+        :'integrity_impact' => :'integrity_impact',
+        :'privileges_required' => :'privileges_required',
+        :'scope' => :'scope',
+        :'score' => :'score',
+        :'severity' => :'severity',
+        :'user_interaction' => :'user_interaction'
+      }
+    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
+      {
+        :'attack_complexity' => :'String',
+        :'attack_vector' => :'String',
+        :'availability_impact' => :'String',
+        :'confidentiality_impact' => :'String',
+        :'integrity_impact' => :'String',
+        :'privileges_required' => :'String',
+        :'scope' => :'String',
+        :'score' => :'Float',
+        :'severity' => :'String',
+        :'user_interaction' => :'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 `Falcon::DomainVulnerabilityCvssV3` 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 `Falcon::DomainVulnerabilityCvssV3`. 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?(:'attack_complexity')
+        self.attack_complexity = attributes[:'attack_complexity']
+      end
+
+      if attributes.key?(:'attack_vector')
+        self.attack_vector = attributes[:'attack_vector']
+      end
+
+      if attributes.key?(:'availability_impact')
+        self.availability_impact = attributes[:'availability_impact']
+      end
+
+      if attributes.key?(:'confidentiality_impact')
+        self.confidentiality_impact = attributes[:'confidentiality_impact']
+      end
+
+      if attributes.key?(:'integrity_impact')
+        self.integrity_impact = attributes[:'integrity_impact']
+      end
+
+      if attributes.key?(:'privileges_required')
+        self.privileges_required = attributes[:'privileges_required']
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      end
+
+      if attributes.key?(:'score')
+        self.score = attributes[:'score']
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      end
+
+      if attributes.key?(:'user_interaction')
+        self.user_interaction = attributes[:'user_interaction']
+      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
+      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?
+      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 &&
+          attack_complexity == o.attack_complexity &&
+          attack_vector == o.attack_vector &&
+          availability_impact == o.availability_impact &&
+          confidentiality_impact == o.confidentiality_impact &&
+          integrity_impact == o.integrity_impact &&
+          privileges_required == o.privileges_required &&
+          scope == o.scope &&
+          score == o.score &&
+          severity == o.severity &&
+          user_interaction == o.user_interaction
+    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
+      [attack_complexity, attack_vector, availability_impact, confidentiality_impact, integrity_impact, privileges_required, scope, score, severity, user_interaction].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[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
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Falcon.const_get(type)
+        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