crimson-falcon 1.0.1 → 1.1.0

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

@@ -0,0 +1,311 @@
+=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 DomainAPIAggregateComplianceByClusterTypeV1
+    attr_accessor :cluster_type
+
+    attr_accessor :failed_rules_count
+
+    attr_accessor :passed_rules_count
+
+    attr_accessor :percentage_of_passed_rules
+
+    attr_accessor :rule_status_list
+
+    attr_accessor :total_rules_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cluster_type' => :'cluster_type',
+        :'failed_rules_count' => :'failed_rules_count',
+        :'passed_rules_count' => :'passed_rules_count',
+        :'percentage_of_passed_rules' => :'percentage_of_passed_rules',
+        :'rule_status_list' => :'rule_status_list',
+        :'total_rules_count' => :'total_rules_count'
+      }
+    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
+      {
+        :'cluster_type' => :'String',
+        :'failed_rules_count' => :'Integer',
+        :'passed_rules_count' => :'Integer',
+        :'percentage_of_passed_rules' => :'Float',
+        :'rule_status_list' => :'Array<DomainAPIAssetComplianceFindingV1>',
+        :'total_rules_count' => :'Integer'
+      }
+    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::DomainAPIAggregateComplianceByClusterTypeV1` 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::DomainAPIAggregateComplianceByClusterTypeV1`. 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?(:'cluster_type')
+        self.cluster_type = attributes[:'cluster_type']
+      end
+
+      if attributes.key?(:'failed_rules_count')
+        self.failed_rules_count = attributes[:'failed_rules_count']
+      end
+
+      if attributes.key?(:'passed_rules_count')
+        self.passed_rules_count = attributes[:'passed_rules_count']
+      end
+
+      if attributes.key?(:'percentage_of_passed_rules')
+        self.percentage_of_passed_rules = attributes[:'percentage_of_passed_rules']
+      end
+
+      if attributes.key?(:'rule_status_list')
+        if (value = attributes[:'rule_status_list']).is_a?(Array)
+          self.rule_status_list = value
+        end
+      end
+
+      if attributes.key?(:'total_rules_count')
+        self.total_rules_count = attributes[:'total_rules_count']
+      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 @cluster_type.nil?
+        invalid_properties.push('invalid value for "cluster_type", cluster_type cannot be nil.')
+      end
+
+      if @failed_rules_count.nil?
+        invalid_properties.push('invalid value for "failed_rules_count", failed_rules_count cannot be nil.')
+      end
+
+      if @passed_rules_count.nil?
+        invalid_properties.push('invalid value for "passed_rules_count", passed_rules_count cannot be nil.')
+      end
+
+      if @percentage_of_passed_rules.nil?
+        invalid_properties.push('invalid value for "percentage_of_passed_rules", percentage_of_passed_rules cannot be nil.')
+      end
+
+      if @rule_status_list.nil?
+        invalid_properties.push('invalid value for "rule_status_list", rule_status_list cannot be nil.')
+      end
+
+      if @total_rules_count.nil?
+        invalid_properties.push('invalid value for "total_rules_count", total_rules_count 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 @cluster_type.nil?
+      return false if @failed_rules_count.nil?
+      return false if @passed_rules_count.nil?
+      return false if @percentage_of_passed_rules.nil?
+      return false if @rule_status_list.nil?
+      return false if @total_rules_count.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 &&
+          cluster_type == o.cluster_type &&
+          failed_rules_count == o.failed_rules_count &&
+          passed_rules_count == o.passed_rules_count &&
+          percentage_of_passed_rules == o.percentage_of_passed_rules &&
+          rule_status_list == o.rule_status_list &&
+          total_rules_count == o.total_rules_count
+    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
+      [cluster_type, failed_rules_count, passed_rules_count, percentage_of_passed_rules, rule_status_list, total_rules_count].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_aggregate_compliance_by_framework_v1.rb

@@ -0,0 +1,339 @@
+=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 DomainAPIAggregateComplianceByFrameworkV1
+    attr_accessor :failed_rules_count
+
+    attr_accessor :framework_name
+
+    attr_accessor :framework_name_version
+
+    attr_accessor :framework_version
+
+    attr_accessor :passed_rules_count
+
+    attr_accessor :percentage_of_passed_rules
+
+    attr_accessor :rule_status_list
+
+    attr_accessor :total_rules_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'failed_rules_count' => :'failed_rules_count',
+        :'framework_name' => :'framework_name',
+        :'framework_name_version' => :'framework_name_version',
+        :'framework_version' => :'framework_version',
+        :'passed_rules_count' => :'passed_rules_count',
+        :'percentage_of_passed_rules' => :'percentage_of_passed_rules',
+        :'rule_status_list' => :'rule_status_list',
+        :'total_rules_count' => :'total_rules_count'
+      }
+    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
+      {
+        :'failed_rules_count' => :'Integer',
+        :'framework_name' => :'String',
+        :'framework_name_version' => :'String',
+        :'framework_version' => :'String',
+        :'passed_rules_count' => :'Integer',
+        :'percentage_of_passed_rules' => :'Float',
+        :'rule_status_list' => :'Array<DomainAPIAssetComplianceFindingV1>',
+        :'total_rules_count' => :'Integer'
+      }
+    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::DomainAPIAggregateComplianceByFrameworkV1` 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::DomainAPIAggregateComplianceByFrameworkV1`. 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?(:'failed_rules_count')
+        self.failed_rules_count = attributes[:'failed_rules_count']
+      end
+
+      if attributes.key?(:'framework_name')
+        self.framework_name = attributes[:'framework_name']
+      end
+
+      if attributes.key?(:'framework_name_version')
+        self.framework_name_version = attributes[:'framework_name_version']
+      end
+
+      if attributes.key?(:'framework_version')
+        self.framework_version = attributes[:'framework_version']
+      end
+
+      if attributes.key?(:'passed_rules_count')
+        self.passed_rules_count = attributes[:'passed_rules_count']
+      end
+
+      if attributes.key?(:'percentage_of_passed_rules')
+        self.percentage_of_passed_rules = attributes[:'percentage_of_passed_rules']
+      end
+
+      if attributes.key?(:'rule_status_list')
+        if (value = attributes[:'rule_status_list']).is_a?(Array)
+          self.rule_status_list = value
+        end
+      end
+
+      if attributes.key?(:'total_rules_count')
+        self.total_rules_count = attributes[:'total_rules_count']
+      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 @failed_rules_count.nil?
+        invalid_properties.push('invalid value for "failed_rules_count", failed_rules_count cannot be nil.')
+      end
+
+      if @framework_name.nil?
+        invalid_properties.push('invalid value for "framework_name", framework_name cannot be nil.')
+      end
+
+      if @framework_name_version.nil?
+        invalid_properties.push('invalid value for "framework_name_version", framework_name_version cannot be nil.')
+      end
+
+      if @framework_version.nil?
+        invalid_properties.push('invalid value for "framework_version", framework_version cannot be nil.')
+      end
+
+      if @passed_rules_count.nil?
+        invalid_properties.push('invalid value for "passed_rules_count", passed_rules_count cannot be nil.')
+      end
+
+      if @percentage_of_passed_rules.nil?
+        invalid_properties.push('invalid value for "percentage_of_passed_rules", percentage_of_passed_rules cannot be nil.')
+      end
+
+      if @rule_status_list.nil?
+        invalid_properties.push('invalid value for "rule_status_list", rule_status_list cannot be nil.')
+      end
+
+      if @total_rules_count.nil?
+        invalid_properties.push('invalid value for "total_rules_count", total_rules_count 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 @failed_rules_count.nil?
+      return false if @framework_name.nil?
+      return false if @framework_name_version.nil?
+      return false if @framework_version.nil?
+      return false if @passed_rules_count.nil?
+      return false if @percentage_of_passed_rules.nil?
+      return false if @rule_status_list.nil?
+      return false if @total_rules_count.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 &&
+          failed_rules_count == o.failed_rules_count &&
+          framework_name == o.framework_name &&
+          framework_name_version == o.framework_name_version &&
+          framework_version == o.framework_version &&
+          passed_rules_count == o.passed_rules_count &&
+          percentage_of_passed_rules == o.percentage_of_passed_rules &&
+          rule_status_list == o.rule_status_list &&
+          total_rules_count == o.total_rules_count
+    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
+      [failed_rules_count, framework_name, framework_name_version, framework_version, passed_rules_count, percentage_of_passed_rules, rule_status_list, total_rules_count].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