crimson-falcon 0.3.0 → 0.4.0

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

@@ -32,15 +32,27 @@ require 'time'
 
 module Falcon
   class DomainMetaInfo
-    attr_accessor :msa_meta_info
+    attr_accessor :pagination
+
+    attr_accessor :powered_by
+
+    attr_accessor :query_time
 
     attr_accessor :quota
 
+    attr_accessor :trace_id
+
+    attr_accessor :writes
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'msa_meta_info' => :'MsaMetaInfo',
-        :'quota' => :'quota'
+        :'pagination' => :'pagination',
+        :'powered_by' => :'powered_by',
+        :'query_time' => :'query_time',
+        :'quota' => :'quota',
+        :'trace_id' => :'trace_id',
+        :'writes' => :'writes'
       }
     end
 
@@ -52,8 +64,12 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'msa_meta_info' => :'MsaspecMetaInfo',
-        :'quota' => :'DomainQuota'
+        :'pagination' => :'MsaspecPaging',
+        :'powered_by' => :'String',
+        :'query_time' => :'Float',
+        :'quota' => :'DomainQuota',
+        :'trace_id' => :'String',
+        :'writes' => :'MsaspecWrites'
       }
     end
 
@@ -78,21 +94,41 @@ module Falcon
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'msa_meta_info')
-        self.msa_meta_info = attributes[:'msa_meta_info']
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      end
+
+      if attributes.key?(:'powered_by')
+        self.powered_by = attributes[:'powered_by']
+      end
+
+      if attributes.key?(:'query_time')
+        self.query_time = attributes[:'query_time']
       end
 
       if attributes.key?(:'quota')
         self.quota = attributes[:'quota']
       end
+
+      if attributes.key?(:'trace_id')
+        self.trace_id = attributes[:'trace_id']
+      end
+
+      if attributes.key?(:'writes')
+        self.writes = attributes[:'writes']
+      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 @msa_meta_info.nil?
-        invalid_properties.push('invalid value for "msa_meta_info", msa_meta_info cannot be nil.')
+      if @query_time.nil?
+        invalid_properties.push('invalid value for "query_time", query_time cannot be nil.')
+      end
+
+      if @trace_id.nil?
+        invalid_properties.push('invalid value for "trace_id", trace_id cannot be nil.')
       end
 
       invalid_properties
@@ -101,7 +137,8 @@ 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 @msa_meta_info.nil?
+      return false if @query_time.nil?
+      return false if @trace_id.nil?
       true
     end
 
@@ -110,8 +147,12 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          msa_meta_info == o.msa_meta_info &&
-          quota == o.quota
+          pagination == o.pagination &&
+          powered_by == o.powered_by &&
+          query_time == o.query_time &&
+          quota == o.quota &&
+          trace_id == o.trace_id &&
+          writes == o.writes
     end
 
     # @see the `==` method
@@ -123,7 +164,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [msa_meta_info, quota].hash
+      [pagination, powered_by, query_time, quota, trace_id, writes].hash
     end
 
     # Builds the object from hash

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

@@ -58,6 +58,9 @@ module Falcon
     # Date of the news document last modification, unix timestampt
     attr_accessor :last_modified_date
 
+    # Malware mentioned, related or referenced in the news/report
+    attr_accessor :malware
+
     # News mentioned motivation or motivation of related actors and malware families
     attr_accessor :motivations
 
@@ -108,6 +111,7 @@ module Falcon
         :'id' => :'id',
         :'image' => :'image',
         :'last_modified_date' => :'last_modified_date',
+        :'malware' => :'malware',
         :'motivations' => :'motivations',
         :'name' => :'name',
         :'notify_users' => :'notify_users',
@@ -142,6 +146,7 @@ module Falcon
         :'id' => :'Integer',
         :'image' => :'DomainImage',
         :'last_modified_date' => :'Integer',
+        :'malware' => :'Array<DomainReportMalware>',
         :'motivations' => :'Array<DomainEntity>',
         :'name' => :'String',
         :'notify_users' => :'Boolean',
@@ -222,6 +227,12 @@ module Falcon
         self.last_modified_date = attributes[:'last_modified_date']
       end
 
+      if attributes.key?(:'malware')
+        if (value = attributes[:'malware']).is_a?(Array)
+          self.malware = value
+        end
+      end
+
       if attributes.key?(:'motivations')
         if (value = attributes[:'motivations']).is_a?(Array)
           self.motivations = value
@@ -369,6 +380,7 @@ module Falcon
           id == o.id &&
           image == o.image &&
           last_modified_date == o.last_modified_date &&
+          malware == o.malware &&
           motivations == o.motivations &&
           name == o.name &&
           notify_users == o.notify_users &&
@@ -394,7 +406,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [active, actors, attachments, created_date, description, entitlements, id, image, last_modified_date, motivations, name, notify_users, rich_text_description, short_description, slug, sub_type, tags, target_countries, target_industries, thumbnail, topic, type, url].hash
+      [active, actors, attachments, created_date, description, entitlements, id, image, last_modified_date, malware, motivations, name, notify_users, rich_text_description, short_description, slug, sub_type, tags, target_countries, target_industries, thumbnail, topic, type, url].hash
     end
 
     # Builds the object from hash

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

@@ -32,6 +32,8 @@ require 'time'
 
 module Falcon
   class DomainNotificationV1
+    attr_accessor :actor_slug
+
     # The email of the user who is assigned to this notification
     attr_accessor :assigned_to_uid
 
@@ -106,6 +108,7 @@ module Falcon
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'actor_slug' => :'actor_slug',
         :'assigned_to_uid' => :'assigned_to_uid',
         :'assigned_to_username' => :'assigned_to_username',
         :'assigned_to_uuid' => :'assigned_to_uuid',
@@ -142,6 +145,7 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'actor_slug' => :'String',
         :'assigned_to_uid' => :'String',
         :'assigned_to_username' => :'String',
         :'assigned_to_uuid' => :'String',
@@ -191,6 +195,10 @@ module Falcon
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'actor_slug')
+        self.actor_slug = attributes[:'actor_slug']
+      end
+
       if attributes.key?(:'assigned_to_uid')
         self.assigned_to_uid = attributes[:'assigned_to_uid']
       end
@@ -300,6 +308,10 @@ module Falcon
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @actor_slug.nil?
+        invalid_properties.push('invalid value for "actor_slug", actor_slug cannot be nil.')
+      end
+
       if @cid.nil?
         invalid_properties.push('invalid value for "cid", cid cannot be nil.')
       end
@@ -358,6 +370,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 @actor_slug.nil?
       return false if @cid.nil?
       return false if @created_date.nil?
       return false if @id.nil?
@@ -379,6 +392,7 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          actor_slug == o.actor_slug &&
           assigned_to_uid == o.assigned_to_uid &&
           assigned_to_username == o.assigned_to_username &&
           assigned_to_uuid == o.assigned_to_uuid &&
@@ -415,7 +429,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [assigned_to_uid, assigned_to_username, assigned_to_uuid, breach_summary, cid, created_date, highlights, id, item_author, item_author_id, item_date, item_id, item_site, item_site_id, item_type, logs, raw_intel_id, rule_id, rule_name, rule_priority, rule_topic, source_category, status, typosquatting, updated_date].hash
+      [actor_slug, assigned_to_uid, assigned_to_username, assigned_to_uuid, breach_summary, cid, created_date, highlights, id, item_author, item_author_id, item_date, item_id, item_site, item_site_id, item_type, logs, raw_intel_id, rule_id, rule_name, rule_priority, rule_topic, source_category, status, typosquatting, updated_date].hash
     end
 
     # Builds the object from hash

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

@@ -86,6 +86,10 @@ module Falcon
 
     attr_accessor :fql_policy
 
+    attr_accessor :hipaa_benchmark_ids
+
+    attr_accessor :hitrust_benchmark_ids
+
     attr_accessor :internal_only
 
     attr_accessor :is_enabled
@@ -164,6 +168,8 @@ module Falcon
         :'description' => :'description',
         :'event_type' => :'event_type',
         :'fql_policy' => :'fql_policy',
+        :'hipaa_benchmark_ids' => :'hipaa_benchmark_ids',
+        :'hitrust_benchmark_ids' => :'hitrust_benchmark_ids',
         :'internal_only' => :'internal_only',
         :'is_enabled' => :'is_enabled',
         :'is_remediable' => :'is_remediable',
@@ -226,6 +232,8 @@ module Falcon
         :'description' => :'String',
         :'event_type' => :'String',
         :'fql_policy' => :'String',
+        :'hipaa_benchmark_ids' => :'Array<Integer>',
+        :'hitrust_benchmark_ids' => :'Array<Integer>',
         :'internal_only' => :'Boolean',
         :'is_enabled' => :'Boolean',
         :'is_remediable' => :'Boolean',
@@ -388,6 +396,18 @@ module Falcon
         self.fql_policy = attributes[:'fql_policy']
       end
 
+      if attributes.key?(:'hipaa_benchmark_ids')
+        if (value = attributes[:'hipaa_benchmark_ids']).is_a?(Array)
+          self.hipaa_benchmark_ids = value
+        end
+      end
+
+      if attributes.key?(:'hitrust_benchmark_ids')
+        if (value = attributes[:'hitrust_benchmark_ids']).is_a?(Array)
+          self.hitrust_benchmark_ids = value
+        end
+      end
+
       if attributes.key?(:'internal_only')
         self.internal_only = attributes[:'internal_only']
       end
@@ -573,6 +593,8 @@ module Falcon
           description == o.description &&
           event_type == o.event_type &&
           fql_policy == o.fql_policy &&
+          hipaa_benchmark_ids == o.hipaa_benchmark_ids &&
+          hitrust_benchmark_ids == o.hitrust_benchmark_ids &&
           internal_only == o.internal_only &&
           is_enabled == o.is_enabled &&
           is_remediable == o.is_remediable &&
@@ -608,7 +630,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [created_at, deleted_at, id, updated_at, account_scope, alert_logic, api_command, asset_type_id, attack_tool, attack_tool_command, attack_types, cis_benchmark_ids, cisa_benchmark_ids, cli_command, cloud_asset_type, cloud_document, cloud_platform, cloud_platform_type, cloud_service, cloud_service_friendly, cloud_service_subtype, cloud_service_type, confidence, default_severity, description, event_type, fql_policy, internal_only, is_enabled, is_remediable, iso_benchmark_ids, mitre_attack_cloud_matrix, mitre_attack_cloud_subtype, nist_benchmark_ids, pci_benchmark_ids, policy_confidence_score, policy_fail_query, policy_pass_query, policy_remediation, policy_severity, policy_severity_score, policy_statement, policy_type, remediation_summary, soc2_benchmark_ids, tactic, tactic_id, tactic_url, technique, technique_id, technique_url].hash
+      [created_at, deleted_at, id, updated_at, account_scope, alert_logic, api_command, asset_type_id, attack_tool, attack_tool_command, attack_types, cis_benchmark_ids, cisa_benchmark_ids, cli_command, cloud_asset_type, cloud_document, cloud_platform, cloud_platform_type, cloud_service, cloud_service_friendly, cloud_service_subtype, cloud_service_type, confidence, default_severity, description, event_type, fql_policy, hipaa_benchmark_ids, hitrust_benchmark_ids, internal_only, is_enabled, is_remediable, iso_benchmark_ids, mitre_attack_cloud_matrix, mitre_attack_cloud_subtype, nist_benchmark_ids, pci_benchmark_ids, policy_confidence_score, policy_fail_query, policy_pass_query, policy_remediation, policy_severity, policy_severity_score, policy_statement, policy_type, remediation_summary, soc2_benchmark_ids, tactic, tactic_id, tactic_url, technique, technique_id, technique_url].hash
     end
 
     # Builds the object from hash

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

@@ -55,8 +55,8 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'errors' => :'Array<MsaspecError>',
-        :'meta' => :'DomainMsaMetaInfo',
+        :'errors' => :'Array<DomainReconAPIError>',
+        :'meta' => :'MsaspecMetaInfo',
         :'resources' => :'Array<String>'
       }
     end
@@ -103,6 +103,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 +121,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

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

@@ -0,0 +1,264 @@
+=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 DomainReportMalware
+    attr_accessor :community_identifiers
+
+    attr_accessor :family_name
+
+    attr_accessor :slug
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'community_identifiers' => :'community_identifiers',
+        :'family_name' => :'family_name',
+        :'slug' => :'slug'
+      }
+    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
+      {
+        :'community_identifiers' => :'Array<String>',
+        :'family_name' => :'String',
+        :'slug' => :'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::DomainReportMalware` 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::DomainReportMalware`. 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?(:'community_identifiers')
+        if (value = attributes[:'community_identifiers']).is_a?(Array)
+          self.community_identifiers = value
+        end
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'slug')
+        self.slug = attributes[:'slug']
+      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 @family_name.nil?
+        invalid_properties.push('invalid value for "family_name", family_name cannot be nil.')
+      end
+
+      if @slug.nil?
+        invalid_properties.push('invalid value for "slug", slug 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 @family_name.nil?
+      return false if @slug.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 &&
+          community_identifiers == o.community_identifiers &&
+          family_name == o.family_name &&
+          slug == o.slug
+    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
+      [community_identifiers, family_name, slug].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