crimson-falcon 0.3.0 → 0.4.0

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

@@ -0,0 +1,621 @@
+=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 DomainScanV2
+    attr_accessor :affected_hosts_count
+
+    attr_accessor :cid
+
+    attr_accessor :cloud_ml_level_detection
+
+    attr_accessor :cloud_ml_level_prevention
+
+    attr_accessor :completed_host_count
+
+    attr_accessor :cpu_priority
+
+    attr_accessor :created_by
+
+    attr_accessor :created_on
+
+    attr_accessor :description
+
+    attr_accessor :endpoint_notification
+
+    attr_accessor :file_paths
+
+    attr_accessor :filecount
+
+    attr_accessor :host_groups
+
+    attr_accessor :hosts
+
+    attr_accessor :id
+
+    attr_accessor :incomplete_host_count
+
+    attr_accessor :initiated_from
+
+    attr_accessor :last_updated
+
+    attr_accessor :max_duration
+
+    attr_accessor :max_file_size
+
+    attr_accessor :metadata
+
+    attr_accessor :missing_host_count
+
+    attr_accessor :not_started_host_count
+
+    attr_accessor :pause_duration
+
+    attr_accessor :policy_setting
+
+    attr_accessor :preemption_priority
+
+    attr_accessor :profile_id
+
+    attr_accessor :quarantine
+
+    attr_accessor :scan_completed_on
+
+    attr_accessor :scan_exclusions
+
+    attr_accessor :scan_inclusions
+
+    attr_accessor :scan_started_on
+
+    attr_accessor :sensor_ml_level_detection
+
+    attr_accessor :sensor_ml_level_prevention
+
+    attr_accessor :severity
+
+    attr_accessor :started_host_count
+
+    attr_accessor :status
+
+    attr_accessor :targeted_host_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'affected_hosts_count' => :'affected_hosts_count',
+        :'cid' => :'cid',
+        :'cloud_ml_level_detection' => :'cloud_ml_level_detection',
+        :'cloud_ml_level_prevention' => :'cloud_ml_level_prevention',
+        :'completed_host_count' => :'completed_host_count',
+        :'cpu_priority' => :'cpu_priority',
+        :'created_by' => :'created_by',
+        :'created_on' => :'created_on',
+        :'description' => :'description',
+        :'endpoint_notification' => :'endpoint_notification',
+        :'file_paths' => :'file_paths',
+        :'filecount' => :'filecount',
+        :'host_groups' => :'host_groups',
+        :'hosts' => :'hosts',
+        :'id' => :'id',
+        :'incomplete_host_count' => :'incomplete_host_count',
+        :'initiated_from' => :'initiated_from',
+        :'last_updated' => :'last_updated',
+        :'max_duration' => :'max_duration',
+        :'max_file_size' => :'max_file_size',
+        :'metadata' => :'metadata',
+        :'missing_host_count' => :'missing_host_count',
+        :'not_started_host_count' => :'not_started_host_count',
+        :'pause_duration' => :'pause_duration',
+        :'policy_setting' => :'policy_setting',
+        :'preemption_priority' => :'preemption_priority',
+        :'profile_id' => :'profile_id',
+        :'quarantine' => :'quarantine',
+        :'scan_completed_on' => :'scan_completed_on',
+        :'scan_exclusions' => :'scan_exclusions',
+        :'scan_inclusions' => :'scan_inclusions',
+        :'scan_started_on' => :'scan_started_on',
+        :'sensor_ml_level_detection' => :'sensor_ml_level_detection',
+        :'sensor_ml_level_prevention' => :'sensor_ml_level_prevention',
+        :'severity' => :'severity',
+        :'started_host_count' => :'started_host_count',
+        :'status' => :'status',
+        :'targeted_host_count' => :'targeted_host_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
+      {
+        :'affected_hosts_count' => :'Integer',
+        :'cid' => :'String',
+        :'cloud_ml_level_detection' => :'Integer',
+        :'cloud_ml_level_prevention' => :'Integer',
+        :'completed_host_count' => :'Integer',
+        :'cpu_priority' => :'Integer',
+        :'created_by' => :'String',
+        :'created_on' => :'Time',
+        :'description' => :'String',
+        :'endpoint_notification' => :'Boolean',
+        :'file_paths' => :'Array<String>',
+        :'filecount' => :'DomainFileCountV2',
+        :'host_groups' => :'Array<String>',
+        :'hosts' => :'Array<String>',
+        :'id' => :'String',
+        :'incomplete_host_count' => :'Integer',
+        :'initiated_from' => :'String',
+        :'last_updated' => :'Time',
+        :'max_duration' => :'Integer',
+        :'max_file_size' => :'Integer',
+        :'metadata' => :'Array<String>',
+        :'missing_host_count' => :'Integer',
+        :'not_started_host_count' => :'Integer',
+        :'pause_duration' => :'Integer',
+        :'policy_setting' => :'Array<Integer>',
+        :'preemption_priority' => :'Integer',
+        :'profile_id' => :'String',
+        :'quarantine' => :'Boolean',
+        :'scan_completed_on' => :'Time',
+        :'scan_exclusions' => :'Array<String>',
+        :'scan_inclusions' => :'Array<String>',
+        :'scan_started_on' => :'Time',
+        :'sensor_ml_level_detection' => :'Integer',
+        :'sensor_ml_level_prevention' => :'Integer',
+        :'severity' => :'Integer',
+        :'started_host_count' => :'Integer',
+        :'status' => :'String',
+        :'targeted_host_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::DomainScanV2` 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::DomainScanV2`. 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?(:'affected_hosts_count')
+        self.affected_hosts_count = attributes[:'affected_hosts_count']
+      end
+
+      if attributes.key?(:'cid')
+        self.cid = attributes[:'cid']
+      end
+
+      if attributes.key?(:'cloud_ml_level_detection')
+        self.cloud_ml_level_detection = attributes[:'cloud_ml_level_detection']
+      end
+
+      if attributes.key?(:'cloud_ml_level_prevention')
+        self.cloud_ml_level_prevention = attributes[:'cloud_ml_level_prevention']
+      end
+
+      if attributes.key?(:'completed_host_count')
+        self.completed_host_count = attributes[:'completed_host_count']
+      end
+
+      if attributes.key?(:'cpu_priority')
+        self.cpu_priority = attributes[:'cpu_priority']
+      end
+
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
+      end
+
+      if attributes.key?(:'created_on')
+        self.created_on = attributes[:'created_on']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'endpoint_notification')
+        self.endpoint_notification = attributes[:'endpoint_notification']
+      end
+
+      if attributes.key?(:'file_paths')
+        if (value = attributes[:'file_paths']).is_a?(Array)
+          self.file_paths = value
+        end
+      end
+
+      if attributes.key?(:'filecount')
+        self.filecount = attributes[:'filecount']
+      end
+
+      if attributes.key?(:'host_groups')
+        if (value = attributes[:'host_groups']).is_a?(Array)
+          self.host_groups = value
+        end
+      end
+
+      if attributes.key?(:'hosts')
+        if (value = attributes[:'hosts']).is_a?(Array)
+          self.hosts = value
+        end
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'incomplete_host_count')
+        self.incomplete_host_count = attributes[:'incomplete_host_count']
+      end
+
+      if attributes.key?(:'initiated_from')
+        self.initiated_from = attributes[:'initiated_from']
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      end
+
+      if attributes.key?(:'max_duration')
+        self.max_duration = attributes[:'max_duration']
+      end
+
+      if attributes.key?(:'max_file_size')
+        self.max_file_size = attributes[:'max_file_size']
+      end
+
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Array)
+          self.metadata = value
+        end
+      end
+
+      if attributes.key?(:'missing_host_count')
+        self.missing_host_count = attributes[:'missing_host_count']
+      end
+
+      if attributes.key?(:'not_started_host_count')
+        self.not_started_host_count = attributes[:'not_started_host_count']
+      end
+
+      if attributes.key?(:'pause_duration')
+        self.pause_duration = attributes[:'pause_duration']
+      end
+
+      if attributes.key?(:'policy_setting')
+        if (value = attributes[:'policy_setting']).is_a?(Array)
+          self.policy_setting = value
+        end
+      end
+
+      if attributes.key?(:'preemption_priority')
+        self.preemption_priority = attributes[:'preemption_priority']
+      end
+
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
+      end
+
+      if attributes.key?(:'quarantine')
+        self.quarantine = attributes[:'quarantine']
+      end
+
+      if attributes.key?(:'scan_completed_on')
+        self.scan_completed_on = attributes[:'scan_completed_on']
+      end
+
+      if attributes.key?(:'scan_exclusions')
+        if (value = attributes[:'scan_exclusions']).is_a?(Array)
+          self.scan_exclusions = value
+        end
+      end
+
+      if attributes.key?(:'scan_inclusions')
+        if (value = attributes[:'scan_inclusions']).is_a?(Array)
+          self.scan_inclusions = value
+        end
+      end
+
+      if attributes.key?(:'scan_started_on')
+        self.scan_started_on = attributes[:'scan_started_on']
+      end
+
+      if attributes.key?(:'sensor_ml_level_detection')
+        self.sensor_ml_level_detection = attributes[:'sensor_ml_level_detection']
+      end
+
+      if attributes.key?(:'sensor_ml_level_prevention')
+        self.sensor_ml_level_prevention = attributes[:'sensor_ml_level_prevention']
+      end
+
+      if attributes.key?(:'severity')
+        self.severity = attributes[:'severity']
+      end
+
+      if attributes.key?(:'started_host_count')
+        self.started_host_count = attributes[:'started_host_count']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'targeted_host_count')
+        self.targeted_host_count = attributes[:'targeted_host_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 @affected_hosts_count.nil?
+        invalid_properties.push('invalid value for "affected_hosts_count", affected_hosts_count cannot be nil.')
+      end
+
+      if @completed_host_count.nil?
+        invalid_properties.push('invalid value for "completed_host_count", completed_host_count cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @incomplete_host_count.nil?
+        invalid_properties.push('invalid value for "incomplete_host_count", incomplete_host_count cannot be nil.')
+      end
+
+      if @missing_host_count.nil?
+        invalid_properties.push('invalid value for "missing_host_count", missing_host_count cannot be nil.')
+      end
+
+      if @not_started_host_count.nil?
+        invalid_properties.push('invalid value for "not_started_host_count", not_started_host_count cannot be nil.')
+      end
+
+      if @started_host_count.nil?
+        invalid_properties.push('invalid value for "started_host_count", started_host_count cannot be nil.')
+      end
+
+      if @targeted_host_count.nil?
+        invalid_properties.push('invalid value for "targeted_host_count", targeted_host_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 @affected_hosts_count.nil?
+      return false if @completed_host_count.nil?
+      return false if @id.nil?
+      return false if @incomplete_host_count.nil?
+      return false if @missing_host_count.nil?
+      return false if @not_started_host_count.nil?
+      return false if @started_host_count.nil?
+      return false if @targeted_host_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 &&
+          affected_hosts_count == o.affected_hosts_count &&
+          cid == o.cid &&
+          cloud_ml_level_detection == o.cloud_ml_level_detection &&
+          cloud_ml_level_prevention == o.cloud_ml_level_prevention &&
+          completed_host_count == o.completed_host_count &&
+          cpu_priority == o.cpu_priority &&
+          created_by == o.created_by &&
+          created_on == o.created_on &&
+          description == o.description &&
+          endpoint_notification == o.endpoint_notification &&
+          file_paths == o.file_paths &&
+          filecount == o.filecount &&
+          host_groups == o.host_groups &&
+          hosts == o.hosts &&
+          id == o.id &&
+          incomplete_host_count == o.incomplete_host_count &&
+          initiated_from == o.initiated_from &&
+          last_updated == o.last_updated &&
+          max_duration == o.max_duration &&
+          max_file_size == o.max_file_size &&
+          metadata == o.metadata &&
+          missing_host_count == o.missing_host_count &&
+          not_started_host_count == o.not_started_host_count &&
+          pause_duration == o.pause_duration &&
+          policy_setting == o.policy_setting &&
+          preemption_priority == o.preemption_priority &&
+          profile_id == o.profile_id &&
+          quarantine == o.quarantine &&
+          scan_completed_on == o.scan_completed_on &&
+          scan_exclusions == o.scan_exclusions &&
+          scan_inclusions == o.scan_inclusions &&
+          scan_started_on == o.scan_started_on &&
+          sensor_ml_level_detection == o.sensor_ml_level_detection &&
+          sensor_ml_level_prevention == o.sensor_ml_level_prevention &&
+          severity == o.severity &&
+          started_host_count == o.started_host_count &&
+          status == o.status &&
+          targeted_host_count == o.targeted_host_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
+      [affected_hosts_count, cid, cloud_ml_level_detection, cloud_ml_level_prevention, completed_host_count, cpu_priority, created_by, created_on, description, endpoint_notification, file_paths, filecount, host_groups, hosts, id, incomplete_host_count, initiated_from, last_updated, max_duration, max_file_size, metadata, missing_host_count, not_started_host_count, pause_duration, policy_setting, preemption_priority, profile_id, quarantine, scan_completed_on, scan_exclusions, scan_inclusions, scan_started_on, sensor_ml_level_detection, sensor_ml_level_prevention, severity, started_host_count, status, targeted_host_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