crimson-falcon 0.5.0 → 1.0.1

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

@@ -0,0 +1,365 @@
+=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 ModelsResultProperties
+    attr_accessor :asset_id
+
+    attr_accessor :asset_name
+
+    attr_accessor :asset_type
+
+    attr_accessor :cid
+
+    attr_accessor :cloud_account_id
+
+    attr_accessor :cloud_account_name
+
+    attr_accessor :cloud_provider
+
+    attr_accessor :function_type
+
+    attr_accessor :is_supported
+
+    attr_accessor :region
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'asset_id' => :'assetID',
+        :'asset_name' => :'assetName',
+        :'asset_type' => :'assetType',
+        :'cid' => :'cid',
+        :'cloud_account_id' => :'cloudAccountID',
+        :'cloud_account_name' => :'cloudAccountName',
+        :'cloud_provider' => :'cloudProvider',
+        :'function_type' => :'functionType',
+        :'is_supported' => :'isSupported',
+        :'region' => :'region'
+      }
+    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
+      {
+        :'asset_id' => :'String',
+        :'asset_name' => :'String',
+        :'asset_type' => :'String',
+        :'cid' => :'String',
+        :'cloud_account_id' => :'String',
+        :'cloud_account_name' => :'String',
+        :'cloud_provider' => :'String',
+        :'function_type' => :'String',
+        :'is_supported' => :'Boolean',
+        :'region' => :'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::ModelsResultProperties` 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::ModelsResultProperties`. 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?(:'asset_id')
+        self.asset_id = attributes[:'asset_id']
+      end
+
+      if attributes.key?(:'asset_name')
+        self.asset_name = attributes[:'asset_name']
+      end
+
+      if attributes.key?(:'asset_type')
+        self.asset_type = attributes[:'asset_type']
+      end
+
+      if attributes.key?(:'cid')
+        self.cid = attributes[:'cid']
+      end
+
+      if attributes.key?(:'cloud_account_id')
+        self.cloud_account_id = attributes[:'cloud_account_id']
+      end
+
+      if attributes.key?(:'cloud_account_name')
+        self.cloud_account_name = attributes[:'cloud_account_name']
+      end
+
+      if attributes.key?(:'cloud_provider')
+        self.cloud_provider = attributes[:'cloud_provider']
+      end
+
+      if attributes.key?(:'function_type')
+        self.function_type = attributes[:'function_type']
+      end
+
+      if attributes.key?(:'is_supported')
+        self.is_supported = attributes[:'is_supported']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      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 @asset_id.nil?
+        invalid_properties.push('invalid value for "asset_id", asset_id cannot be nil.')
+      end
+
+      if @asset_name.nil?
+        invalid_properties.push('invalid value for "asset_name", asset_name cannot be nil.')
+      end
+
+      if @asset_type.nil?
+        invalid_properties.push('invalid value for "asset_type", asset_type cannot be nil.')
+      end
+
+      if @cid.nil?
+        invalid_properties.push('invalid value for "cid", cid cannot be nil.')
+      end
+
+      if @cloud_account_id.nil?
+        invalid_properties.push('invalid value for "cloud_account_id", cloud_account_id cannot be nil.')
+      end
+
+      if @cloud_account_name.nil?
+        invalid_properties.push('invalid value for "cloud_account_name", cloud_account_name cannot be nil.')
+      end
+
+      if @cloud_provider.nil?
+        invalid_properties.push('invalid value for "cloud_provider", cloud_provider cannot be nil.')
+      end
+
+      if @function_type.nil?
+        invalid_properties.push('invalid value for "function_type", function_type cannot be nil.')
+      end
+
+      if @is_supported.nil?
+        invalid_properties.push('invalid value for "is_supported", is_supported cannot be nil.')
+      end
+
+      if @region.nil?
+        invalid_properties.push('invalid value for "region", region 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 @asset_id.nil?
+      return false if @asset_name.nil?
+      return false if @asset_type.nil?
+      return false if @cid.nil?
+      return false if @cloud_account_id.nil?
+      return false if @cloud_account_name.nil?
+      return false if @cloud_provider.nil?
+      return false if @function_type.nil?
+      return false if @is_supported.nil?
+      return false if @region.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 &&
+          asset_id == o.asset_id &&
+          asset_name == o.asset_name &&
+          asset_type == o.asset_type &&
+          cid == o.cid &&
+          cloud_account_id == o.cloud_account_id &&
+          cloud_account_name == o.cloud_account_name &&
+          cloud_provider == o.cloud_provider &&
+          function_type == o.function_type &&
+          is_supported == o.is_supported &&
+          region == o.region
+    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
+      [asset_id, asset_name, asset_type, cid, cloud_account_id, cloud_account_name, cloud_provider, function_type, is_supported, region].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_rule.rb

@@ -0,0 +1,337 @@
+=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 ModelsRule
+    attr_accessor :default_configuration
+
+    attr_accessor :full_description
+
+    attr_accessor :help
+
+    attr_accessor :help_uri
+
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :properties
+
+    attr_accessor :short_description
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'default_configuration' => :'defaultConfiguration',
+        :'full_description' => :'fullDescription',
+        :'help' => :'help',
+        :'help_uri' => :'helpUri',
+        :'id' => :'id',
+        :'name' => :'name',
+        :'properties' => :'properties',
+        :'short_description' => :'shortDescription'
+      }
+    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
+      {
+        :'default_configuration' => :'ModelsRuleDefaultConfiguration',
+        :'full_description' => :'ModelsMessage',
+        :'help' => :'Help',
+        :'help_uri' => :'String',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'properties' => :'ModelsRuleProperties',
+        :'short_description' => :'ModelsMessage'
+      }
+    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::ModelsRule` 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::ModelsRule`. 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?(:'default_configuration')
+        self.default_configuration = attributes[:'default_configuration']
+      end
+
+      if attributes.key?(:'full_description')
+        self.full_description = attributes[:'full_description']
+      end
+
+      if attributes.key?(:'help')
+        self.help = attributes[:'help']
+      end
+
+      if attributes.key?(:'help_uri')
+        self.help_uri = attributes[:'help_uri']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'properties')
+        self.properties = attributes[:'properties']
+      end
+
+      if attributes.key?(:'short_description')
+        self.short_description = attributes[:'short_description']
+      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 @default_configuration.nil?
+        invalid_properties.push('invalid value for "default_configuration", default_configuration cannot be nil.')
+      end
+
+      if @full_description.nil?
+        invalid_properties.push('invalid value for "full_description", full_description cannot be nil.')
+      end
+
+      if @help.nil?
+        invalid_properties.push('invalid value for "help", help cannot be nil.')
+      end
+
+      if @help_uri.nil?
+        invalid_properties.push('invalid value for "help_uri", help_uri cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @properties.nil?
+        invalid_properties.push('invalid value for "properties", properties cannot be nil.')
+      end
+
+      if @short_description.nil?
+        invalid_properties.push('invalid value for "short_description", short_description 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 @default_configuration.nil?
+      return false if @full_description.nil?
+      return false if @help.nil?
+      return false if @help_uri.nil?
+      return false if @id.nil?
+      return false if @name.nil?
+      return false if @properties.nil?
+      return false if @short_description.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 &&
+          default_configuration == o.default_configuration &&
+          full_description == o.full_description &&
+          help == o.help &&
+          help_uri == o.help_uri &&
+          id == o.id &&
+          name == o.name &&
+          properties == o.properties &&
+          short_description == o.short_description
+    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
+      [default_configuration, full_description, help, help_uri, id, name, properties, short_description].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