crimson-falcon 0.3.0 → 0.4.1

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

@@ -0,0 +1,434 @@
+=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 DomainAPIRuleDetailsV1
+    attr_accessor :additional_information
+
+    attr_accessor :applicable_profiles
+
+    attr_accessor :assessment_status
+
+    attr_accessor :audit_procedure
+
+    attr_accessor :authority
+
+    attr_accessor :benchmark_title
+
+    attr_accessor :description
+
+    attr_accessor :id
+
+    attr_accessor :impact_statement
+
+    attr_accessor :platform
+
+    attr_accessor :rationale_statement
+
+    attr_accessor :recommendation_id
+
+    attr_accessor :references
+
+    attr_accessor :remediation_procedure
+
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'additional_information' => :'additional_information',
+        :'applicable_profiles' => :'applicable_profiles',
+        :'assessment_status' => :'assessment_status',
+        :'audit_procedure' => :'audit_procedure',
+        :'authority' => :'authority',
+        :'benchmark_title' => :'benchmark_title',
+        :'description' => :'description',
+        :'id' => :'id',
+        :'impact_statement' => :'impact_statement',
+        :'platform' => :'platform',
+        :'rationale_statement' => :'rationale_statement',
+        :'recommendation_id' => :'recommendation_id',
+        :'references' => :'references',
+        :'remediation_procedure' => :'remediation_procedure',
+        :'title' => :'title'
+      }
+    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
+      {
+        :'additional_information' => :'String',
+        :'applicable_profiles' => :'Array<String>',
+        :'assessment_status' => :'String',
+        :'audit_procedure' => :'String',
+        :'authority' => :'String',
+        :'benchmark_title' => :'String',
+        :'description' => :'String',
+        :'id' => :'String',
+        :'impact_statement' => :'String',
+        :'platform' => :'String',
+        :'rationale_statement' => :'String',
+        :'recommendation_id' => :'String',
+        :'references' => :'Array<String>',
+        :'remediation_procedure' => :'String',
+        :'title' => :'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::DomainAPIRuleDetailsV1` 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::DomainAPIRuleDetailsV1`. 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?(:'additional_information')
+        self.additional_information = attributes[:'additional_information']
+      end
+
+      if attributes.key?(:'applicable_profiles')
+        if (value = attributes[:'applicable_profiles']).is_a?(Array)
+          self.applicable_profiles = value
+        end
+      end
+
+      if attributes.key?(:'assessment_status')
+        self.assessment_status = attributes[:'assessment_status']
+      end
+
+      if attributes.key?(:'audit_procedure')
+        self.audit_procedure = attributes[:'audit_procedure']
+      end
+
+      if attributes.key?(:'authority')
+        self.authority = attributes[:'authority']
+      end
+
+      if attributes.key?(:'benchmark_title')
+        self.benchmark_title = attributes[:'benchmark_title']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'impact_statement')
+        self.impact_statement = attributes[:'impact_statement']
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      end
+
+      if attributes.key?(:'rationale_statement')
+        self.rationale_statement = attributes[:'rationale_statement']
+      end
+
+      if attributes.key?(:'recommendation_id')
+        self.recommendation_id = attributes[:'recommendation_id']
+      end
+
+      if attributes.key?(:'references')
+        if (value = attributes[:'references']).is_a?(Array)
+          self.references = value
+        end
+      end
+
+      if attributes.key?(:'remediation_procedure')
+        self.remediation_procedure = attributes[:'remediation_procedure']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      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
+      if @additional_information.nil?
+        invalid_properties.push('invalid value for "additional_information", additional_information cannot be nil.')
+      end
+
+      if @applicable_profiles.nil?
+        invalid_properties.push('invalid value for "applicable_profiles", applicable_profiles cannot be nil.')
+      end
+
+      if @assessment_status.nil?
+        invalid_properties.push('invalid value for "assessment_status", assessment_status cannot be nil.')
+      end
+
+      if @audit_procedure.nil?
+        invalid_properties.push('invalid value for "audit_procedure", audit_procedure cannot be nil.')
+      end
+
+      if @authority.nil?
+        invalid_properties.push('invalid value for "authority", authority cannot be nil.')
+      end
+
+      if @benchmark_title.nil?
+        invalid_properties.push('invalid value for "benchmark_title", benchmark_title cannot be nil.')
+      end
+
+      if @description.nil?
+        invalid_properties.push('invalid value for "description", description cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @impact_statement.nil?
+        invalid_properties.push('invalid value for "impact_statement", impact_statement cannot be nil.')
+      end
+
+      if @platform.nil?
+        invalid_properties.push('invalid value for "platform", platform cannot be nil.')
+      end
+
+      if @rationale_statement.nil?
+        invalid_properties.push('invalid value for "rationale_statement", rationale_statement cannot be nil.')
+      end
+
+      if @recommendation_id.nil?
+        invalid_properties.push('invalid value for "recommendation_id", recommendation_id cannot be nil.')
+      end
+
+      if @remediation_procedure.nil?
+        invalid_properties.push('invalid value for "remediation_procedure", remediation_procedure cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      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?
+      return false if @additional_information.nil?
+      return false if @applicable_profiles.nil?
+      return false if @assessment_status.nil?
+      return false if @audit_procedure.nil?
+      return false if @authority.nil?
+      return false if @benchmark_title.nil?
+      return false if @description.nil?
+      return false if @id.nil?
+      return false if @impact_statement.nil?
+      return false if @platform.nil?
+      return false if @rationale_statement.nil?
+      return false if @recommendation_id.nil?
+      return false if @remediation_procedure.nil?
+      return false if @title.nil?
+      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 &&
+          additional_information == o.additional_information &&
+          applicable_profiles == o.applicable_profiles &&
+          assessment_status == o.assessment_status &&
+          audit_procedure == o.audit_procedure &&
+          authority == o.authority &&
+          benchmark_title == o.benchmark_title &&
+          description == o.description &&
+          id == o.id &&
+          impact_statement == o.impact_statement &&
+          platform == o.platform &&
+          rationale_statement == o.rationale_statement &&
+          recommendation_id == o.recommendation_id &&
+          references == o.references &&
+          remediation_procedure == o.remediation_procedure &&
+          title == o.title
+    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
+      [additional_information, applicable_profiles, assessment_status, audit_procedure, authority, benchmark_title, description, id, impact_statement, platform, rationale_statement, recommendation_id, references, remediation_procedure, title].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_api_vulnerability_app_v2.rb

@@ -32,11 +32,16 @@ require 'time'
 
 module Falcon
   class DomainAPIVulnerabilityAppV2
+    # Refers to the normalized product name of the product for which the vulnerability has been detected
+    attr_accessor :product_name_normalized
+
+    # Refers to the un-normalized combination of product name and version of the product for which the vulnerability has been detected
     attr_accessor :product_name_version
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'product_name_normalized' => :'product_name_normalized',
         :'product_name_version' => :'product_name_version'
       }
     end
@@ -49,6 +54,7 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'product_name_normalized' => :'String',
         :'product_name_version' => :'String'
       }
     end
@@ -74,6 +80,10 @@ module Falcon
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'product_name_normalized')
+        self.product_name_normalized = attributes[:'product_name_normalized']
+      end
+
       if attributes.key?(:'product_name_version')
         self.product_name_version = attributes[:'product_name_version']
       end
@@ -83,6 +93,10 @@ module Falcon
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @product_name_normalized.nil?
+        invalid_properties.push('invalid value for "product_name_normalized", product_name_normalized cannot be nil.')
+      end
+
       if @product_name_version.nil?
         invalid_properties.push('invalid value for "product_name_version", product_name_version cannot be nil.')
       end
@@ -93,6 +107,7 @@ module Falcon
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @product_name_normalized.nil?
       return false if @product_name_version.nil?
       true
     end
@@ -102,6 +117,7 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          product_name_normalized == o.product_name_normalized &&
           product_name_version == o.product_name_version
     end
 
@@ -114,7 +130,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [product_name_version].hash
+      [product_name_normalized, product_name_version].hash
     end
 
     # Builds the object from hash

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

@@ -75,6 +75,9 @@ module Falcon
     # Corresponds to a point in time when Spotlight offered support for detecting a specific vulnerability
     attr_accessor :spotlight_published_date
 
+    # The types of vulnerability. Can be of: Vulnerability, Misconfiguration, and Unsupported software
+    attr_accessor :types
+
     # Refers to the vector of attack or the specific method or path through which an attacker can exploit a vulnerability
     attr_accessor :vector
 
@@ -99,6 +102,7 @@ module Falcon
         :'remediation_level' => :'remediation_level',
         :'severity' => :'severity',
         :'spotlight_published_date' => :'spotlight_published_date',
+        :'types' => :'types',
         :'vector' => :'vector',
         :'vendor_advisory' => :'vendor_advisory'
       }
@@ -127,6 +131,7 @@ module Falcon
         :'remediation_level' => :'String',
         :'severity' => :'String',
         :'spotlight_published_date' => :'String',
+        :'types' => :'Array<String>',
         :'vector' => :'String',
         :'vendor_advisory' => :'Array<String>'
       }
@@ -217,6 +222,12 @@ module Falcon
         self.spotlight_published_date = attributes[:'spotlight_published_date']
       end
 
+      if attributes.key?(:'types')
+        if (value = attributes[:'types']).is_a?(Array)
+          self.types = value
+        end
+      end
+
       if attributes.key?(:'vector')
         self.vector = attributes[:'vector']
       end
@@ -266,6 +277,7 @@ module Falcon
           remediation_level == o.remediation_level &&
           severity == o.severity &&
           spotlight_published_date == o.spotlight_published_date &&
+          types == o.types &&
           vector == o.vector &&
           vendor_advisory == o.vendor_advisory
     end
@@ -279,7 +291,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [actors, base_score, cisa_info, description, exploit_status, exploitability_score, exprt_rating, id, impact_score, name, published_date, references, remediation_level, severity, spotlight_published_date, vector, vendor_advisory].hash
+      [actors, base_score, cisa_info, description, exploit_status, exploitability_score, exprt_rating, id, impact_score, name, published_date, references, remediation_level, severity, spotlight_published_date, types, vector, vendor_advisory].hash
     end
 
     # Builds the object from hash

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

@@ -34,6 +34,10 @@ module Falcon
   class DomainAPIVulnerabilityExtendedAppV2
     attr_accessor :evaluation_logic
 
+    # Refers to the normalized product name of the product for which the vulnerability has been detected
+    attr_accessor :product_name_normalized
+
+    # Refers to the un-normalized combination of product name and version of the product for which the vulnerability has been detected
     attr_accessor :product_name_version
 
     attr_accessor :remediation
@@ -45,6 +49,7 @@ module Falcon
     def self.attribute_map
       {
         :'evaluation_logic' => :'evaluation_logic',
+        :'product_name_normalized' => :'product_name_normalized',
         :'product_name_version' => :'product_name_version',
         :'remediation' => :'remediation',
         :'sub_status' => :'sub_status'
@@ -60,6 +65,7 @@ module Falcon
     def self.openapi_types
       {
         :'evaluation_logic' => :'DomainAPIEvaluationLogicV1',
+        :'product_name_normalized' => :'String',
         :'product_name_version' => :'String',
         :'remediation' => :'DomainAPIRemediationIDs',
         :'sub_status' => :'String'
@@ -91,6 +97,10 @@ module Falcon
         self.evaluation_logic = attributes[:'evaluation_logic']
       end
 
+      if attributes.key?(:'product_name_normalized')
+        self.product_name_normalized = attributes[:'product_name_normalized']
+      end
+
       if attributes.key?(:'product_name_version')
         self.product_name_version = attributes[:'product_name_version']
       end
@@ -108,6 +118,10 @@ module Falcon
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @product_name_normalized.nil?
+        invalid_properties.push('invalid value for "product_name_normalized", product_name_normalized cannot be nil.')
+      end
+
       if @product_name_version.nil?
         invalid_properties.push('invalid value for "product_name_version", product_name_version cannot be nil.')
       end
@@ -118,6 +132,7 @@ module Falcon
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      return false if @product_name_normalized.nil?
       return false if @product_name_version.nil?
       true
     end
@@ -128,6 +143,7 @@ module Falcon
       return true if self.equal?(o)
       self.class == o.class &&
           evaluation_logic == o.evaluation_logic &&
+          product_name_normalized == o.product_name_normalized &&
           product_name_version == o.product_name_version &&
           remediation == o.remediation &&
           sub_status == o.sub_status
@@ -142,7 +158,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [evaluation_logic, product_name_version, remediation, sub_status].hash
+      [evaluation_logic, product_name_normalized, product_name_version, remediation, sub_status].hash
     end
 
     # Builds the object from hash

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

@@ -38,9 +38,6 @@ module Falcon
     # Refers to one or more roles that have been assigned to the assets
     attr_accessor :asset_roles
 
-    # A unique identifier assigned by entity graph
-    attr_accessor :entity_graph_id
-
     # Refers to a logic grouping of assets
     attr_accessor :groups
 
@@ -103,7 +100,6 @@ module Falcon
       {
         :'asset_criticality' => :'asset_criticality',
         :'asset_roles' => :'asset_roles',
-        :'entity_graph_id' => :'entity_graph_id',
         :'groups' => :'groups',
         :'host_last_seen_timestamp' => :'host_last_seen_timestamp',
         :'hostname' => :'hostname',
@@ -136,7 +132,6 @@ module Falcon
       {
         :'asset_criticality' => :'String',
         :'asset_roles' => :'Array<String>',
-        :'entity_graph_id' => :'String',
         :'groups' => :'Array<DomainAPIHostGroup>',
         :'host_last_seen_timestamp' => :'String',
         :'hostname' => :'String',
@@ -190,10 +185,6 @@ module Falcon
         end
       end
 
-      if attributes.key?(:'entity_graph_id')
-        self.entity_graph_id = attributes[:'entity_graph_id']
-      end
-
       if attributes.key?(:'groups')
         if (value = attributes[:'groups']).is_a?(Array)
           self.groups = value
@@ -332,7 +323,6 @@ module Falcon
       self.class == o.class &&
           asset_criticality == o.asset_criticality &&
           asset_roles == o.asset_roles &&
-          entity_graph_id == o.entity_graph_id &&
           groups == o.groups &&
           host_last_seen_timestamp == o.host_last_seen_timestamp &&
           hostname == o.hostname &&
@@ -363,7 +353,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [asset_criticality, asset_roles, entity_graph_id, groups, host_last_seen_timestamp, hostname, instance_id, internet_exposure, local_ip, machine_domain, managed_by, os_build, os_version, ou, platform, product_type_desc, service_provider, service_provider_account_id, site_name, system_manufacturer, tags, third_party_asset_ids].hash
+      [asset_criticality, asset_roles, groups, host_last_seen_timestamp, hostname, instance_id, internet_exposure, local_ip, machine_domain, managed_by, os_build, os_version, ou, platform, product_type_desc, service_provider, service_provider_account_id, site_name, system_manufacturer, tags, third_party_asset_ids].hash
     end
 
     # Builds the object from hash