crimson-falcon 1.1.0 → 1.2.0

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

@@ -0,0 +1,279 @@
+=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 ModelsScanInfoType
+    attr_accessor :correlation_uuid
+
+    attr_accessor :requested_at
+
+    attr_accessor :scan_uuid
+
+    attr_accessor :user_uuid
+
+    attr_accessor :username
+
+    attr_accessor :cid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'correlation_uuid' => :'CorrelationUUID',
+        :'requested_at' => :'RequestedAt',
+        :'scan_uuid' => :'ScanUUID',
+        :'user_uuid' => :'UserUUID',
+        :'username' => :'Username',
+        :'cid' => :'cid'
+      }
+    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
+      {
+        :'correlation_uuid' => :'String',
+        :'requested_at' => :'String',
+        :'scan_uuid' => :'String',
+        :'user_uuid' => :'String',
+        :'username' => :'String',
+        :'cid' => :'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::ModelsScanInfoType` 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::ModelsScanInfoType`. 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?(:'correlation_uuid')
+        self.correlation_uuid = attributes[:'correlation_uuid']
+      end
+
+      if attributes.key?(:'requested_at')
+        self.requested_at = attributes[:'requested_at']
+      end
+
+      if attributes.key?(:'scan_uuid')
+        self.scan_uuid = attributes[:'scan_uuid']
+      end
+
+      if attributes.key?(:'user_uuid')
+        self.user_uuid = attributes[:'user_uuid']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'cid')
+        self.cid = attributes[:'cid']
+      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 &&
+          correlation_uuid == o.correlation_uuid &&
+          requested_at == o.requested_at &&
+          scan_uuid == o.scan_uuid &&
+          user_uuid == o.user_uuid &&
+          username == o.username &&
+          cid == o.cid
+    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
+      [correlation_uuid, requested_at, scan_uuid, user_uuid, username, cid].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/models_scan_request_type.rb

@@ -0,0 +1,385 @@
+=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 ModelsScanRequestType
+    attr_accessor :config
+
+    attr_accessor :config_info
+
+    attr_accessor :image_info
+
+    attr_accessor :image_metadata
+
+    attr_accessor :layers
+
+    attr_accessor :manifest
+
+    attr_accessor :scan_info
+
+    attr_accessor :high_entropy_strings_s3_key
+
+    attr_accessor :image_inventory_s3_key
+
+    attr_accessor :layer_inventory_s3_key
+
+    attr_accessor :scan_report_s3_key
+
+    attr_accessor :scan_request_s3_key
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'config' => :'Config',
+        :'config_info' => :'ConfigInfo',
+        :'image_info' => :'ImageInfo',
+        :'image_metadata' => :'ImageMetadata',
+        :'layers' => :'Layers',
+        :'manifest' => :'Manifest',
+        :'scan_info' => :'ScanInfo',
+        :'high_entropy_strings_s3_key' => :'high_entropy_strings_s3_key',
+        :'image_inventory_s3_key' => :'image_inventory_s3_key',
+        :'layer_inventory_s3_key' => :'layer_inventory_s3_key',
+        :'scan_report_s3_key' => :'scan_report_s3_key',
+        :'scan_request_s3_key' => :'scan_request_s3_key'
+      }
+    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
+      {
+        :'config' => :'V1Image',
+        :'config_info' => :'ModelsConfigInfoType',
+        :'image_info' => :'ModelsImageInfoType',
+        :'image_metadata' => :'ModelsImageMetadataType',
+        :'layers' => :'Array<ModelsLayerInfoType>',
+        :'manifest' => :'Schema2Manifest',
+        :'scan_info' => :'ModelsScanInfoType',
+        :'high_entropy_strings_s3_key' => :'String',
+        :'image_inventory_s3_key' => :'String',
+        :'layer_inventory_s3_key' => :'String',
+        :'scan_report_s3_key' => :'String',
+        :'scan_request_s3_key' => :'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::ModelsScanRequestType` 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::ModelsScanRequestType`. 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?(:'config')
+        self.config = attributes[:'config']
+      end
+
+      if attributes.key?(:'config_info')
+        self.config_info = attributes[:'config_info']
+      end
+
+      if attributes.key?(:'image_info')
+        self.image_info = attributes[:'image_info']
+      end
+
+      if attributes.key?(:'image_metadata')
+        self.image_metadata = attributes[:'image_metadata']
+      end
+
+      if attributes.key?(:'layers')
+        if (value = attributes[:'layers']).is_a?(Array)
+          self.layers = value
+        end
+      end
+
+      if attributes.key?(:'manifest')
+        self.manifest = attributes[:'manifest']
+      end
+
+      if attributes.key?(:'scan_info')
+        self.scan_info = attributes[:'scan_info']
+      end
+
+      if attributes.key?(:'high_entropy_strings_s3_key')
+        self.high_entropy_strings_s3_key = attributes[:'high_entropy_strings_s3_key']
+      end
+
+      if attributes.key?(:'image_inventory_s3_key')
+        self.image_inventory_s3_key = attributes[:'image_inventory_s3_key']
+      end
+
+      if attributes.key?(:'layer_inventory_s3_key')
+        self.layer_inventory_s3_key = attributes[:'layer_inventory_s3_key']
+      end
+
+      if attributes.key?(:'scan_report_s3_key')
+        self.scan_report_s3_key = attributes[:'scan_report_s3_key']
+      end
+
+      if attributes.key?(:'scan_request_s3_key')
+        self.scan_request_s3_key = attributes[:'scan_request_s3_key']
+      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 @config.nil?
+        invalid_properties.push('invalid value for "config", config cannot be nil.')
+      end
+
+      if @config_info.nil?
+        invalid_properties.push('invalid value for "config_info", config_info cannot be nil.')
+      end
+
+      if @image_metadata.nil?
+        invalid_properties.push('invalid value for "image_metadata", image_metadata cannot be nil.')
+      end
+
+      if @layers.nil?
+        invalid_properties.push('invalid value for "layers", layers cannot be nil.')
+      end
+
+      if @manifest.nil?
+        invalid_properties.push('invalid value for "manifest", manifest cannot be nil.')
+      end
+
+      if @high_entropy_strings_s3_key.nil?
+        invalid_properties.push('invalid value for "high_entropy_strings_s3_key", high_entropy_strings_s3_key cannot be nil.')
+      end
+
+      if @image_inventory_s3_key.nil?
+        invalid_properties.push('invalid value for "image_inventory_s3_key", image_inventory_s3_key cannot be nil.')
+      end
+
+      if @layer_inventory_s3_key.nil?
+        invalid_properties.push('invalid value for "layer_inventory_s3_key", layer_inventory_s3_key cannot be nil.')
+      end
+
+      if @scan_report_s3_key.nil?
+        invalid_properties.push('invalid value for "scan_report_s3_key", scan_report_s3_key cannot be nil.')
+      end
+
+      if @scan_request_s3_key.nil?
+        invalid_properties.push('invalid value for "scan_request_s3_key", scan_request_s3_key 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 @config.nil?
+      return false if @config_info.nil?
+      return false if @image_metadata.nil?
+      return false if @layers.nil?
+      return false if @manifest.nil?
+      return false if @high_entropy_strings_s3_key.nil?
+      return false if @image_inventory_s3_key.nil?
+      return false if @layer_inventory_s3_key.nil?
+      return false if @scan_report_s3_key.nil?
+      return false if @scan_request_s3_key.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 &&
+          config == o.config &&
+          config_info == o.config_info &&
+          image_info == o.image_info &&
+          image_metadata == o.image_metadata &&
+          layers == o.layers &&
+          manifest == o.manifest &&
+          scan_info == o.scan_info &&
+          high_entropy_strings_s3_key == o.high_entropy_strings_s3_key &&
+          image_inventory_s3_key == o.image_inventory_s3_key &&
+          layer_inventory_s3_key == o.layer_inventory_s3_key &&
+          scan_report_s3_key == o.scan_report_s3_key &&
+          scan_request_s3_key == o.scan_request_s3_key
+    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
+      [config, config_info, image_info, image_metadata, layers, manifest, scan_info, high_entropy_strings_s3_key, image_inventory_s3_key, layer_inventory_s3_key, scan_report_s3_key, scan_request_s3_key].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