crimson-falcon 0.5.0 → 1.0.1

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

@@ -0,0 +1,458 @@
+=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 FigapiIndicator
+    attr_accessor :adversaries
+
+    attr_accessor :certificates
+
+    attr_accessor :countries
+
+    attr_accessor :domain_details
+
+    attr_accessor :file_details
+
+    # Indicators first seen
+    attr_accessor :first_seen
+
+    # The indicator ID. Concatenation of type and indicator fields. Based on the CKB2 vertex ID.
+    attr_accessor :id
+
+    attr_accessor :ipv4_details
+
+    attr_accessor :ipv6_details
+
+    # Multi field property describing indicators kill-chain, possible properties: `ActionOnObjectives`, `C2`, `Delivery`, `Exploitation`, `Installation`, `Reconnaissance`, `Weaponization`
+    attr_accessor :kill_chain
+
+    # Indicators last seen
+    attr_accessor :last_seen
+
+    attr_accessor :last_updated
+
+    # Indicates a confidence level by which an indicator is considered to be malicious, this can be one of: `Low`, `Medium`, `High`
+    attr_accessor :malicious_confidence
+
+    # Indicates when was the confidence was last set
+    attr_accessor :malicious_confidence_validated_time
+
+    attr_accessor :publish_date
+
+    attr_accessor :reports
+
+    attr_accessor :sectors
+
+    attr_accessor :threat_types
+
+    attr_accessor :threats
+
+    # Type of the indicator, this can be one of: `File`, `Domain`, `IPv4`, `IPv6`, `URL`
+    attr_accessor :type
+
+    attr_accessor :url_details
+
+    # TBD
+    attr_accessor :victimology
+
+    attr_accessor :vulnerabilities
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'adversaries' => :'Adversaries',
+        :'certificates' => :'Certificates',
+        :'countries' => :'Countries',
+        :'domain_details' => :'DomainDetails',
+        :'file_details' => :'FileDetails',
+        :'first_seen' => :'FirstSeen',
+        :'id' => :'ID',
+        :'ipv4_details' => :'IPv4Details',
+        :'ipv6_details' => :'IPv6Details',
+        :'kill_chain' => :'KillChain',
+        :'last_seen' => :'LastSeen',
+        :'last_updated' => :'LastUpdated',
+        :'malicious_confidence' => :'MaliciousConfidence',
+        :'malicious_confidence_validated_time' => :'MaliciousConfidenceValidatedTime',
+        :'publish_date' => :'PublishDate',
+        :'reports' => :'Reports',
+        :'sectors' => :'Sectors',
+        :'threat_types' => :'ThreatTypes',
+        :'threats' => :'Threats',
+        :'type' => :'Type',
+        :'url_details' => :'URLDetails',
+        :'victimology' => :'Victimology',
+        :'vulnerabilities' => :'Vulnerabilities'
+      }
+    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<FigapiAdversary>',
+        :'certificates' => :'Array<FigapiX509Certificate>',
+        :'countries' => :'Array<FigapiCountry>',
+        :'domain_details' => :'FigapiDomain',
+        :'file_details' => :'FigapiFile',
+        :'first_seen' => :'String',
+        :'id' => :'String',
+        :'ipv4_details' => :'FigapiIPv4',
+        :'ipv6_details' => :'FigapiIPv6',
+        :'kill_chain' => :'Array<String>',
+        :'last_seen' => :'String',
+        :'last_updated' => :'String',
+        :'malicious_confidence' => :'String',
+        :'malicious_confidence_validated_time' => :'String',
+        :'publish_date' => :'String',
+        :'reports' => :'Array<FigapiReport>',
+        :'sectors' => :'Array<FigapiSector>',
+        :'threat_types' => :'Array<String>',
+        :'threats' => :'Array<FigapiThreat>',
+        :'type' => :'String',
+        :'url_details' => :'FigapiURL',
+        :'victimology' => :'String',
+        :'vulnerabilities' => :'Array<FigapiVulnerability>'
+      }
+    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::FigapiIndicator` 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::FigapiIndicator`. 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?(:'certificates')
+        if (value = attributes[:'certificates']).is_a?(Array)
+          self.certificates = value
+        end
+      end
+
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      end
+
+      if attributes.key?(:'domain_details')
+        self.domain_details = attributes[:'domain_details']
+      end
+
+      if attributes.key?(:'file_details')
+        self.file_details = attributes[:'file_details']
+      end
+
+      if attributes.key?(:'first_seen')
+        self.first_seen = attributes[:'first_seen']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'ipv4_details')
+        self.ipv4_details = attributes[:'ipv4_details']
+      end
+
+      if attributes.key?(:'ipv6_details')
+        self.ipv6_details = attributes[:'ipv6_details']
+      end
+
+      if attributes.key?(:'kill_chain')
+        if (value = attributes[:'kill_chain']).is_a?(Array)
+          self.kill_chain = value
+        end
+      end
+
+      if attributes.key?(:'last_seen')
+        self.last_seen = attributes[:'last_seen']
+      end
+
+      if attributes.key?(:'last_updated')
+        self.last_updated = attributes[:'last_updated']
+      end
+
+      if attributes.key?(:'malicious_confidence')
+        self.malicious_confidence = attributes[:'malicious_confidence']
+      end
+
+      if attributes.key?(:'malicious_confidence_validated_time')
+        self.malicious_confidence_validated_time = attributes[:'malicious_confidence_validated_time']
+      end
+
+      if attributes.key?(:'publish_date')
+        self.publish_date = attributes[:'publish_date']
+      end
+
+      if attributes.key?(:'reports')
+        if (value = attributes[:'reports']).is_a?(Array)
+          self.reports = value
+        end
+      end
+
+      if attributes.key?(:'sectors')
+        if (value = attributes[:'sectors']).is_a?(Array)
+          self.sectors = value
+        end
+      end
+
+      if attributes.key?(:'threat_types')
+        if (value = attributes[:'threat_types']).is_a?(Array)
+          self.threat_types = value
+        end
+      end
+
+      if attributes.key?(:'threats')
+        if (value = attributes[:'threats']).is_a?(Array)
+          self.threats = value
+        end
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'url_details')
+        self.url_details = attributes[:'url_details']
+      end
+
+      if attributes.key?(:'victimology')
+        self.victimology = attributes[:'victimology']
+      end
+
+      if attributes.key?(:'vulnerabilities')
+        if (value = attributes[:'vulnerabilities']).is_a?(Array)
+          self.vulnerabilities = value
+        end
+      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 &&
+          adversaries == o.adversaries &&
+          certificates == o.certificates &&
+          countries == o.countries &&
+          domain_details == o.domain_details &&
+          file_details == o.file_details &&
+          first_seen == o.first_seen &&
+          id == o.id &&
+          ipv4_details == o.ipv4_details &&
+          ipv6_details == o.ipv6_details &&
+          kill_chain == o.kill_chain &&
+          last_seen == o.last_seen &&
+          last_updated == o.last_updated &&
+          malicious_confidence == o.malicious_confidence &&
+          malicious_confidence_validated_time == o.malicious_confidence_validated_time &&
+          publish_date == o.publish_date &&
+          reports == o.reports &&
+          sectors == o.sectors &&
+          threat_types == o.threat_types &&
+          threats == o.threats &&
+          type == o.type &&
+          url_details == o.url_details &&
+          victimology == o.victimology &&
+          vulnerabilities == o.vulnerabilities
+    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, certificates, countries, domain_details, file_details, first_seen, id, ipv4_details, ipv6_details, kill_chain, last_seen, last_updated, malicious_confidence, malicious_confidence_validated_time, publish_date, reports, sectors, threat_types, threats, type, url_details, victimology, vulnerabilities].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