crimson-falcon 1.1.0 → 1.2.0

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

@@ -0,0 +1,278 @@
+=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 DomainKestrelDataExportParams
+    attr_accessor :export_mapping
+
+    attr_accessor :gqe_query
+
+    attr_accessor :limit
+
+    attr_accessor :view_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'export_mapping' => :'export_mapping',
+        :'gqe_query' => :'gqe_query',
+        :'limit' => :'limit',
+        :'view_id' => :'view_id'
+      }
+    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
+      {
+        :'export_mapping' => :'Array<DomainKestrelDataExportHeaderMapping>',
+        :'gqe_query' => :'String',
+        :'limit' => :'Integer',
+        :'view_id' => :'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::DomainKestrelDataExportParams` 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::DomainKestrelDataExportParams`. 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?(:'export_mapping')
+        if (value = attributes[:'export_mapping']).is_a?(Array)
+          self.export_mapping = value
+        end
+      end
+
+      if attributes.key?(:'gqe_query')
+        self.gqe_query = attributes[:'gqe_query']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      end
+
+      if attributes.key?(:'view_id')
+        self.view_id = attributes[:'view_id']
+      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 @export_mapping.nil?
+        invalid_properties.push('invalid value for "export_mapping", export_mapping cannot be nil.')
+      end
+
+      if @gqe_query.nil?
+        invalid_properties.push('invalid value for "gqe_query", gqe_query cannot be nil.')
+      end
+
+      if @view_id.nil?
+        invalid_properties.push('invalid value for "view_id", view_id 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 @export_mapping.nil?
+      return false if @gqe_query.nil?
+      return false if @view_id.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 &&
+          export_mapping == o.export_mapping &&
+          gqe_query == o.gqe_query &&
+          limit == o.limit &&
+          view_id == o.view_id
+    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
+      [export_mapping, gqe_query, limit, view_id].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/{quickscanpro_mitre_attack.rb → domain_mitre_attack.rb}

@@ -31,7 +31,7 @@ require 'date'
 require 'time'
 
 module Falcon
-  class QuickscanproMITREAttack
+  class DomainMITREAttack
     attr_accessor :attack_id
 
     attr_accessor :attack_id_wiki
@@ -40,6 +40,10 @@ module Falcon
 
     attr_accessor :description
 
+    attr_accessor :evidence
+
+    attr_accessor :indicator
+
     attr_accessor :parent
 
     attr_accessor :tactic
@@ -53,6 +57,8 @@ module Falcon
         :'attack_id_wiki' => :'attack_id_wiki',
         :'capec_id' => :'capec_id',
         :'description' => :'description',
+        :'evidence' => :'evidence',
+        :'indicator' => :'indicator',
         :'parent' => :'parent',
         :'tactic' => :'tactic',
         :'technique' => :'technique'
@@ -71,7 +77,9 @@ module Falcon
         :'attack_id_wiki' => :'String',
         :'capec_id' => :'String',
         :'description' => :'String',
-        :'parent' => :'QuickscanproMITREAttackParent',
+        :'evidence' => :'String',
+        :'indicator' => :'String',
+        :'parent' => :'DomainMITREAttackParent',
         :'tactic' => :'String',
         :'technique' => :'String'
       }
@@ -87,13 +95,13 @@ module Falcon
     # @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::QuickscanproMITREAttack` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::DomainMITREAttack` 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::QuickscanproMITREAttack`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::DomainMITREAttack`. 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
       }
@@ -114,6 +122,14 @@ module Falcon
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'evidence')
+        self.evidence = attributes[:'evidence']
+      end
+
+      if attributes.key?(:'indicator')
+        self.indicator = attributes[:'indicator']
+      end
+
       if attributes.key?(:'parent')
         self.parent = attributes[:'parent']
       end
@@ -149,6 +165,8 @@ module Falcon
           attack_id_wiki == o.attack_id_wiki &&
           capec_id == o.capec_id &&
           description == o.description &&
+          evidence == o.evidence &&
+          indicator == o.indicator &&
           parent == o.parent &&
           tactic == o.tactic &&
           technique == o.technique
@@ -163,7 +181,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attack_id, attack_id_wiki, capec_id, description, parent, tactic, technique].hash
+      [attack_id, attack_id_wiki, capec_id, description, evidence, indicator, parent, tactic, technique].hash
     end
 
     # Builds the object from hash

data/lib/crimson-falcon/models/{quickscanpro_mitre_attack_parent.rb → domain_mitre_attack_parent.rb}

@@ -31,7 +31,7 @@ require 'date'
 require 'time'
 
 module Falcon
-  class QuickscanproMITREAttackParent
+  class DomainMITREAttackParent
     attr_accessor :attack_id
 
     attr_accessor :attack_id_wiki
@@ -71,13 +71,13 @@ module Falcon
     # @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::QuickscanproMITREAttackParent` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Falcon::DomainMITREAttackParent` 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::QuickscanproMITREAttackParent`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Falcon::DomainMITREAttackParent`. 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
       }

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

@@ -34,13 +34,10 @@ module Falcon
   class DomainMsaMetaInfo
     attr_accessor :pagination
 
-    attr_accessor :query_time
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'pagination' => :'pagination',
-        :'query_time' => :'queryTime'
+        :'pagination' => :'pagination'
       }
     end
 
@@ -52,8 +49,7 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'pagination' => :'MsaPaging',
-        :'query_time' => :'Float'
+        :'pagination' => :'MsaPaging'
       }
     end
 
@@ -81,27 +77,18 @@ module Falcon
       if attributes.key?(:'pagination')
         self.pagination = attributes[:'pagination']
       end
-
-      if attributes.key?(:'query_time')
-        self.query_time = attributes[:'query_time']
-      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 @query_time.nil?
-        invalid_properties.push('invalid value for "query_time", query_time 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 @query_time.nil?
       true
     end
 
@@ -110,8 +97,7 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          pagination == o.pagination &&
-          query_time == o.query_time
+          pagination == o.pagination
     end
 
     # @see the `==` method
@@ -123,7 +109,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pagination, query_time].hash
+      [pagination].hash
     end
 
     # Builds the object from hash

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

@@ -41,7 +41,7 @@ module Falcon
     # News attachment, containing either pdf url or feeds zip and/or gzip archive
     attr_accessor :attachments
 
-    # Date of the news document creation, unix timestampt
+    # Date of the news document creation, Unix timestamp
     attr_accessor :created_date
 
     # Full report description, extracted from the document
@@ -55,7 +55,7 @@ module Falcon
 
     attr_accessor :image
 
-    # Date of the news document last modification, unix timestampt
+    # Date of the news document last modification, Unix timestamp
     attr_accessor :last_modified_date
 
     # Malware mentioned, related or referenced in the news/report

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

@@ -32,6 +32,8 @@ require 'time'
 
 module Falcon
   class DomainNotificationConfig
+    attr_accessor :channel_id
+
     attr_accessor :cid
 
     attr_accessor :config_id
@@ -42,14 +44,18 @@ module Falcon
 
     attr_accessor :severity
 
+    attr_accessor :team_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'channel_id' => :'channel_id',
         :'cid' => :'cid',
         :'config_id' => :'config_id',
         :'plugin_id' => :'plugin_id',
         :'recipients' => :'recipients',
-        :'severity' => :'severity'
+        :'severity' => :'severity',
+        :'team_id' => :'team_id'
       }
     end
 
@@ -61,11 +67,13 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'channel_id' => :'String',
         :'cid' => :'String',
         :'config_id' => :'String',
         :'plugin_id' => :'String',
         :'recipients' => :'Array<String>',
-        :'severity' => :'String'
+        :'severity' => :'String',
+        :'team_id' => :'String'
       }
     end
 
@@ -90,6 +98,10 @@ module Falcon
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'channel_id')
+        self.channel_id = attributes[:'channel_id']
+      end
+
       if attributes.key?(:'cid')
         self.cid = attributes[:'cid']
       end
@@ -111,12 +123,20 @@ module Falcon
       if attributes.key?(:'severity')
         self.severity = attributes[:'severity']
       end
+
+      if attributes.key?(:'team_id')
+        self.team_id = attributes[:'team_id']
+      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 @channel_id.nil?
+        invalid_properties.push('invalid value for "channel_id", channel_id cannot be nil.')
+      end
+
       if @cid.nil?
         invalid_properties.push('invalid value for "cid", cid cannot be nil.')
       end
@@ -137,17 +157,23 @@ module Falcon
         invalid_properties.push('invalid value for "severity", severity cannot be nil.')
       end
 
+      if @team_id.nil?
+        invalid_properties.push('invalid value for "team_id", team_id 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 @channel_id.nil?
       return false if @cid.nil?
       return false if @config_id.nil?
       return false if @plugin_id.nil?
       return false if @recipients.nil?
       return false if @severity.nil?
+      return false if @team_id.nil?
       true
     end
 
@@ -156,11 +182,13 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          channel_id == o.channel_id &&
           cid == o.cid &&
           config_id == o.config_id &&
           plugin_id == o.plugin_id &&
           recipients == o.recipients &&
-          severity == o.severity
+          severity == o.severity &&
+          team_id == o.team_id
     end
 
     # @see the `==` method
@@ -172,7 +200,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [cid, config_id, plugin_id, recipients, severity].hash
+      [channel_id, cid, config_id, plugin_id, recipients, severity, team_id].hash
     end
 
     # Builds the object from hash

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

@@ -32,10 +32,12 @@ require 'time'
 
 module Falcon
   class DomainQueryResponse
+    # Array of API Errors
     attr_accessor :errors
 
     attr_accessor :meta
 
+    # Array of string IDs that matches the query request
     attr_accessor :resources
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -56,7 +58,7 @@ module Falcon
     def self.openapi_types
       {
         :'errors' => :'Array<MsaAPIError>',
-        :'meta' => :'DomainMsaMetaInfo',
+        :'meta' => :'MsaMetaInfo',
         :'resources' => :'Array<String>'
       }
     end
@@ -103,6 +105,10 @@ module Falcon
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @errors.nil?
+        invalid_properties.push('invalid value for "errors", errors cannot be nil.')
+      end
+
       if @meta.nil?
         invalid_properties.push('invalid value for "meta", meta cannot be nil.')
       end
@@ -117,6 +123,7 @@ module Falcon
     # 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 @errors.nil?
       return false if @meta.nil?
       return false if @resources.nil?
       true