crimson-falcon 1.0.1 → 1.1.0

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

@@ -0,0 +1,516 @@
+=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 ApiIntelligenceQueryEntity
+    attr_accessor :adversaries
+
+    attr_accessor :content
+
+    attr_accessor :created_at
+
+    attr_accessor :depends_on
+
+    attr_accessor :description
+
+    # Field only available for Counter Adversary Elite Customers
+    attr_accessor :elite_analyst_notes
+
+    # Field only available for Counter Adversary Elite Customers
+    attr_accessor :elite_query_explainer
+
+    attr_accessor :environment
+
+    attr_accessor :has_elite_analyst_notes
+
+    attr_accessor :has_elite_query_explainer
+
+    attr_accessor :id
+
+    attr_accessor :kill_chain
+
+    attr_accessor :language
+
+    attr_accessor :last_updated_at
+
+    attr_accessor :malware_families
+
+    attr_accessor :mitre_technique_ids
+
+    attr_accessor :name
+
+    attr_accessor :provider
+
+    attr_accessor :relates_to_community_alias
+
+    attr_accessor :reports
+
+    attr_accessor :reports_count
+
+    attr_accessor :subscriptions
+
+    attr_accessor :type
+
+    attr_accessor :version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'adversaries' => :'adversaries',
+        :'content' => :'content',
+        :'created_at' => :'created_at',
+        :'depends_on' => :'depends_on',
+        :'description' => :'description',
+        :'elite_analyst_notes' => :'elite_analyst_notes',
+        :'elite_query_explainer' => :'elite_query_explainer',
+        :'environment' => :'environment',
+        :'has_elite_analyst_notes' => :'has_elite_analyst_notes',
+        :'has_elite_query_explainer' => :'has_elite_query_explainer',
+        :'id' => :'id',
+        :'kill_chain' => :'kill_chain',
+        :'language' => :'language',
+        :'last_updated_at' => :'last_updated_at',
+        :'malware_families' => :'malware_families',
+        :'mitre_technique_ids' => :'mitre_technique_ids',
+        :'name' => :'name',
+        :'provider' => :'provider',
+        :'relates_to_community_alias' => :'relates_to_community_alias',
+        :'reports' => :'reports',
+        :'reports_count' => :'reports_count',
+        :'subscriptions' => :'subscriptions',
+        :'type' => :'type',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'adversaries' => :'Array<String>',
+        :'content' => :'String',
+        :'created_at' => :'Time',
+        :'depends_on' => :'Array<String>',
+        :'description' => :'String',
+        :'elite_analyst_notes' => :'String',
+        :'elite_query_explainer' => :'String',
+        :'environment' => :'Array<String>',
+        :'has_elite_analyst_notes' => :'Boolean',
+        :'has_elite_query_explainer' => :'Boolean',
+        :'id' => :'String',
+        :'kill_chain' => :'Array<String>',
+        :'language' => :'String',
+        :'last_updated_at' => :'Time',
+        :'malware_families' => :'Array<String>',
+        :'mitre_technique_ids' => :'Array<String>',
+        :'name' => :'String',
+        :'provider' => :'String',
+        :'relates_to_community_alias' => :'Array<String>',
+        :'reports' => :'Array<String>',
+        :'reports_count' => :'Integer',
+        :'subscriptions' => :'Array<String>',
+        :'type' => :'String',
+        :'version' => :'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::ApiIntelligenceQueryEntity` 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::ApiIntelligenceQueryEntity`. 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?(:'adversaries')
+        if (value = attributes[:'adversaries']).is_a?(Array)
+          self.adversaries = value
+        end
+      end
+
+      if attributes.key?(:'content')
+        self.content = attributes[:'content']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'depends_on')
+        if (value = attributes[:'depends_on']).is_a?(Array)
+          self.depends_on = value
+        end
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'elite_analyst_notes')
+        self.elite_analyst_notes = attributes[:'elite_analyst_notes']
+      end
+
+      if attributes.key?(:'elite_query_explainer')
+        self.elite_query_explainer = attributes[:'elite_query_explainer']
+      end
+
+      if attributes.key?(:'environment')
+        if (value = attributes[:'environment']).is_a?(Array)
+          self.environment = value
+        end
+      end
+
+      if attributes.key?(:'has_elite_analyst_notes')
+        self.has_elite_analyst_notes = attributes[:'has_elite_analyst_notes']
+      end
+
+      if attributes.key?(:'has_elite_query_explainer')
+        self.has_elite_query_explainer = attributes[:'has_elite_query_explainer']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'kill_chain')
+        if (value = attributes[:'kill_chain']).is_a?(Array)
+          self.kill_chain = value
+        end
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'last_updated_at')
+        self.last_updated_at = attributes[:'last_updated_at']
+      end
+
+      if attributes.key?(:'malware_families')
+        if (value = attributes[:'malware_families']).is_a?(Array)
+          self.malware_families = value
+        end
+      end
+
+      if attributes.key?(:'mitre_technique_ids')
+        if (value = attributes[:'mitre_technique_ids']).is_a?(Array)
+          self.mitre_technique_ids = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      end
+
+      if attributes.key?(:'relates_to_community_alias')
+        if (value = attributes[:'relates_to_community_alias']).is_a?(Array)
+          self.relates_to_community_alias = value
+        end
+      end
+
+      if attributes.key?(:'reports')
+        if (value = attributes[:'reports']).is_a?(Array)
+          self.reports = value
+        end
+      end
+
+      if attributes.key?(:'reports_count')
+        self.reports_count = attributes[:'reports_count']
+      end
+
+      if attributes.key?(:'subscriptions')
+        if (value = attributes[:'subscriptions']).is_a?(Array)
+          self.subscriptions = value
+        end
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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 @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @has_elite_analyst_notes.nil?
+        invalid_properties.push('invalid value for "has_elite_analyst_notes", has_elite_analyst_notes cannot be nil.')
+      end
+
+      if @has_elite_query_explainer.nil?
+        invalid_properties.push('invalid value for "has_elite_query_explainer", has_elite_query_explainer cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @language.nil?
+        invalid_properties.push('invalid value for "language", language cannot be nil.')
+      end
+
+      if @last_updated_at.nil?
+        invalid_properties.push('invalid value for "last_updated_at", last_updated_at cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @reports_count.nil?
+        invalid_properties.push('invalid value for "reports_count", reports_count cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @version.nil?
+        invalid_properties.push('invalid value for "version", version 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 @created_at.nil?
+      return false if @has_elite_analyst_notes.nil?
+      return false if @has_elite_query_explainer.nil?
+      return false if @id.nil?
+      return false if @language.nil?
+      return false if @last_updated_at.nil?
+      return false if @name.nil?
+      return false if @provider.nil?
+      return false if @reports_count.nil?
+      return false if @type.nil?
+      return false if @version.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 &&
+          adversaries == o.adversaries &&
+          content == o.content &&
+          created_at == o.created_at &&
+          depends_on == o.depends_on &&
+          description == o.description &&
+          elite_analyst_notes == o.elite_analyst_notes &&
+          elite_query_explainer == o.elite_query_explainer &&
+          environment == o.environment &&
+          has_elite_analyst_notes == o.has_elite_analyst_notes &&
+          has_elite_query_explainer == o.has_elite_query_explainer &&
+          id == o.id &&
+          kill_chain == o.kill_chain &&
+          language == o.language &&
+          last_updated_at == o.last_updated_at &&
+          malware_families == o.malware_families &&
+          mitre_technique_ids == o.mitre_technique_ids &&
+          name == o.name &&
+          provider == o.provider &&
+          relates_to_community_alias == o.relates_to_community_alias &&
+          reports == o.reports &&
+          reports_count == o.reports_count &&
+          subscriptions == o.subscriptions &&
+          type == o.type &&
+          version == o.version
+    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
+      [adversaries, content, created_at, depends_on, description, elite_analyst_notes, elite_query_explainer, environment, has_elite_analyst_notes, has_elite_query_explainer, id, kill_chain, language, last_updated_at, malware_families, mitre_technique_ids, name, provider, relates_to_community_alias, reports, reports_count, subscriptions, type, version].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