crimson-falcon 1.0.0 → 1.1.0

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

@@ -0,0 +1,319 @@
+=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 ExecutionsFlowExecutionResult
+    attr_accessor :condition
+
+    # Timestamp of when the execution completed. Only present when status is an end state.
+    attr_accessor :end_timestamp
+
+    # When a node execution is in an error status this field is present and provides an error code that can be used to determine details why the failure occurred.
+    attr_accessor :error_code
+
+    # When a node execution is in an error status this field is present and provides a user friendly error message.
+    attr_accessor :error_message
+
+    # Whether this node's result is mocked
+    attr_accessor :mocked
+
+    # Unique id of the node as specified in the definition.
+    attr_accessor :node_id
+
+    # Timestamp of when the execution first started.
+    attr_accessor :start_timestamp
+
+    # Current status of execution for the activity.
+    attr_accessor :status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'condition' => :'condition',
+        :'end_timestamp' => :'end_timestamp',
+        :'error_code' => :'error_code',
+        :'error_message' => :'error_message',
+        :'mocked' => :'mocked',
+        :'node_id' => :'node_id',
+        :'start_timestamp' => :'start_timestamp',
+        :'status' => :'status'
+      }
+    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
+      {
+        :'condition' => :'ExecutionsConditionResult',
+        :'end_timestamp' => :'Time',
+        :'error_code' => :'Integer',
+        :'error_message' => :'String',
+        :'mocked' => :'Boolean',
+        :'node_id' => :'String',
+        :'start_timestamp' => :'Time',
+        :'status' => :'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::ExecutionsFlowExecutionResult` 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::ExecutionsFlowExecutionResult`. 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?(:'condition')
+        self.condition = attributes[:'condition']
+      end
+
+      if attributes.key?(:'end_timestamp')
+        self.end_timestamp = attributes[:'end_timestamp']
+      end
+
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.key?(:'mocked')
+        self.mocked = attributes[:'mocked']
+      end
+
+      if attributes.key?(:'node_id')
+        self.node_id = attributes[:'node_id']
+      end
+
+      if attributes.key?(:'start_timestamp')
+        self.start_timestamp = attributes[:'start_timestamp']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      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 @node_id.nil?
+        invalid_properties.push('invalid value for "node_id", node_id cannot be nil.')
+      end
+
+      if @start_timestamp.nil?
+        invalid_properties.push('invalid value for "start_timestamp", start_timestamp cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @node_id.nil?
+      return false if @start_timestamp.nil?
+      return false if @status.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 &&
+          condition == o.condition &&
+          end_timestamp == o.end_timestamp &&
+          error_code == o.error_code &&
+          error_message == o.error_message &&
+          mocked == o.mocked &&
+          node_id == o.node_id &&
+          start_timestamp == o.start_timestamp &&
+          status == o.status
+    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
+      [condition, end_timestamp, error_code, error_message, mocked, node_id, start_timestamp, status].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/falconx_submission_parameters_v1.rb

@@ -32,6 +32,8 @@ require 'time'
 
 module Falcon
   class FalconxSubmissionParametersV1
+    attr_accessor :auto_detect_environment
+
     attr_accessor :sandbox
 
     attr_accessor :send_email_notification
@@ -41,6 +43,7 @@ module Falcon
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'auto_detect_environment' => :'auto_detect_environment',
         :'sandbox' => :'sandbox',
         :'send_email_notification' => :'send_email_notification',
         :'user_tags' => :'user_tags'
@@ -55,6 +58,7 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'auto_detect_environment' => :'Boolean',
         :'sandbox' => :'Array<FalconxSandboxParametersV1>',
         :'send_email_notification' => :'Boolean',
         :'user_tags' => :'Array<String>'
@@ -82,6 +86,12 @@ module Falcon
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'auto_detect_environment')
+        self.auto_detect_environment = attributes[:'auto_detect_environment']
+      else
+        self.auto_detect_environment = false
+      end
+
       if attributes.key?(:'sandbox')
         if (value = attributes[:'sandbox']).is_a?(Array)
           self.sandbox = value
@@ -117,6 +127,7 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          auto_detect_environment == o.auto_detect_environment &&
           sandbox == o.sandbox &&
           send_email_notification == o.send_email_notification &&
           user_tags == o.user_tags
@@ -131,7 +142,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sandbox, send_email_notification, user_tags].hash
+      [auto_detect_environment, sandbox, send_email_notification, user_tags].hash
     end
 
     # Builds the object from hash

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

@@ -32,6 +32,8 @@ require 'time'
 
 module Falcon
   class FalconxSubmissionV1
+    attr_accessor :auto_detect_environment
+
     attr_accessor :cid
 
     attr_accessor :created_timestamp
@@ -67,6 +69,7 @@ module Falcon
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'auto_detect_environment' => :'auto_detect_environment',
         :'cid' => :'cid',
         :'created_timestamp' => :'created_timestamp',
         :'error_message' => :'error_message',
@@ -94,6 +97,7 @@ module Falcon
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'auto_detect_environment' => :'Boolean',
         :'cid' => :'String',
         :'created_timestamp' => :'String',
         :'error_message' => :'String',
@@ -134,6 +138,12 @@ module Falcon
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'auto_detect_environment')
+        self.auto_detect_environment = attributes[:'auto_detect_environment']
+      else
+        self.auto_detect_environment = false
+      end
+
       if attributes.key?(:'cid')
         self.cid = attributes[:'cid']
       end
@@ -221,6 +231,7 @@ module Falcon
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          auto_detect_environment == o.auto_detect_environment &&
           cid == o.cid &&
           created_timestamp == o.created_timestamp &&
           error_message == o.error_message &&
@@ -248,7 +259,7 @@ module Falcon
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [cid, created_timestamp, error_message, error_origin, error_type, id, index_timestamp, interactive_phase, origin, sandbox, send_email_notification, state, user_id, user_name, user_tags, user_uuid].hash
+      [auto_detect_environment, cid, created_timestamp, error_message, error_origin, error_type, id, index_timestamp, interactive_phase, origin, sandbox, send_email_notification, state, user_id, user_name, user_tags, user_uuid].hash
     end
 
     # Builds the object from hash

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

@@ -34,6 +34,9 @@ module Falcon
   class FigapiIndicator
     attr_accessor :adversaries
 
+    # Total range of customers affected by this indicator
+    attr_accessor :affected_customers
+
     attr_accessor :certificates
 
     attr_accessor :countries
@@ -81,15 +84,13 @@ module Falcon
 
     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',
+        :'affected_customers' => :'AffectedCustomers',
         :'certificates' => :'Certificates',
         :'countries' => :'Countries',
         :'domain_details' => :'DomainDetails',
@@ -110,7 +111,6 @@ module Falcon
         :'threats' => :'Threats',
         :'type' => :'Type',
         :'url_details' => :'URLDetails',
-        :'victimology' => :'Victimology',
         :'vulnerabilities' => :'Vulnerabilities'
       }
     end
@@ -124,6 +124,7 @@ module Falcon
     def self.openapi_types
       {
         :'adversaries' => :'Array<FigapiAdversary>',
+        :'affected_customers' => :'String',
         :'certificates' => :'Array<FigapiX509Certificate>',
         :'countries' => :'Array<FigapiCountry>',
         :'domain_details' => :'FigapiDomain',
@@ -144,7 +145,6 @@ module Falcon
         :'threats' => :'Array<FigapiThreat>',
         :'type' => :'String',
         :'url_details' => :'FigapiURL',
-        :'victimology' => :'String',
         :'vulnerabilities' => :'Array<FigapiVulnerability>'
       }
     end
@@ -176,6 +176,10 @@ module Falcon
         end
       end
 
+      if attributes.key?(:'affected_customers')
+        self.affected_customers = attributes[:'affected_customers']
+      end
+
       if attributes.key?(:'certificates')
         if (value = attributes[:'certificates']).is_a?(Array)
           self.certificates = value
@@ -270,10 +274,6 @@ module Falcon
         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
@@ -300,6 +300,7 @@ module Falcon
       return true if self.equal?(o)
       self.class == o.class &&
           adversaries == o.adversaries &&
+          affected_customers == o.affected_customers &&
           certificates == o.certificates &&
           countries == o.countries &&
           domain_details == o.domain_details &&
@@ -320,7 +321,6 @@ module Falcon
           threats == o.threats &&
           type == o.type &&
           url_details == o.url_details &&
-          victimology == o.victimology &&
           vulnerabilities == o.vulnerabilities
     end
 
@@ -333,7 +333,7 @@ module Falcon
     # 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
+      [adversaries, affected_customers, 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, vulnerabilities].hash
     end
 
     # Builds the object from hash