crimson-falcon 1.1.0 → 1.2.0

data/lib/crimson-falcon/api/system.rb

@@ -0,0 +1,168 @@
+=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 'cgi'
+
+module Falcon
+  class System
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # GET System Logs
+    # Get a list of all system logs
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :from_date From Date (in YYYY-MM-DD format)
+    # @option opts [Integer] :limit The maximum number of objects to return
+    # @option opts [Integer] :offset The starting index of the results
+    # @option opts [Time] :to_date To Date (in YYYY-MM-DD format)
+    # @option opts [Boolean] :total_count Fetch Total Count?
+    # @return [GetSystemLogs]
+    def get_system_logs_v3(opts = {})
+      data, _status_code, _headers = get_system_logs_v3_with_http_info(opts)
+      data
+    end
+
+    # GET System Logs
+    # Get a list of all system logs
+    # @param [Hash] opts the optional parameters
+    # @option opts [Time] :from_date From Date (in YYYY-MM-DD format)
+    # @option opts [Integer] :limit The maximum number of objects to return
+    # @option opts [Integer] :offset The starting index of the results
+    # @option opts [Time] :to_date To Date (in YYYY-MM-DD format)
+    # @option opts [Boolean] :total_count Fetch Total Count?
+    # @return [Array<(GetSystemLogs, Integer, Hash)>] GetSystemLogs data, response status code and response headers
+    def get_system_logs_v3_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: System.get_system_logs_v3 ...'
+      end
+      # resource path
+      local_var_path = '/saas-security/entities/system-logs/v3'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from_date'] = opts[:'from_date'] if !opts[:'from_date'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'to_date'] = opts[:'to_date'] if !opts[:'to_date'].nil?
+      query_params[:'total_count'] = opts[:'total_count'] if !opts[:'total_count'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSystemLogs'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"System.get_system_logs_v3",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: System#get_system_logs_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # GET System Users
+    # Get a list of system users
+    # @param [Hash] opts the optional parameters
+    # @return [GetSystemUsers]
+    def get_system_users_v3(opts = {})
+      data, _status_code, _headers = get_system_users_v3_with_http_info(opts)
+      data
+    end
+
+    # GET System Users
+    # Get a list of system users
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetSystemUsers, Integer, Hash)>] GetSystemUsers data, response status code and response headers
+    def get_system_users_v3_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: System.get_system_users_v3 ...'
+      end
+      # resource path
+      local_var_path = '/saas-security/entities/system-users/v3'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetSystemUsers'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"System.get_system_users_v3",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: System#get_system_users_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/crimson-falcon/api/user_management.rb

@@ -147,7 +147,7 @@ module Falcon
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagement.combined_user_roles_v1, must be greater than or equal to 1.'
       end
 
-      allowable_values = ["cid|asc", "cid|desc", "expires_at|asc", "expires_at|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc"]
+      allowable_values = ["cid|asc", "cid|desc", "expires_at|asc", "expires_at|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc", "user_uuid|asc", "user_uuid|desc"]
       if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
         fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
       end
@@ -243,7 +243,7 @@ module Falcon
         fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling UserManagement.combined_user_roles_v2, must be greater than or equal to 1.'
       end
 
-      allowable_values = ["cid|asc", "cid|desc", "expires_at|asc", "expires_at|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc"]
+      allowable_values = ["cid|asc", "cid|desc", "expires_at|asc", "expires_at|desc", "role_name|asc", "role_name|desc", "type|asc", "type|desc", "user_uuid|asc", "user_uuid|desc"]
       if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
         fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
       end
@@ -1599,7 +1599,7 @@ module Falcon
     end
 
     # Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke
-    # @param body [FlightcontrolapiGrantInput] All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include 'grant' and 'revoke'.
+    # @param body [FlightcontrolapiGrantInput] CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include 'grant' and 'revoke'.
     # @param [Hash] opts the optional parameters
     # @return [MsaspecResponseFields]
     def user_roles_action_v1(body, opts = {})
@@ -1608,7 +1608,7 @@ module Falcon
     end
 
     # Grant or Revoke one or more role(s) to a user against a CID. User UUID, CID and Role ID(s) can be provided in request payload. Available Action(s) : grant, revoke
-    # @param body [FlightcontrolapiGrantInput] All fields including CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include 'grant' and 'revoke'.
+    # @param body [FlightcontrolapiGrantInput] CID, RoleID(s), User UUID and Action are required. Allowed values for Action param include 'grant' and 'revoke'.
     # @param [Hash] opts the optional parameters
     # @return [Array<(MsaspecResponseFields, Integer, Hash)>] MsaspecResponseFields data, response status code and response headers
     def user_roles_action_v1_with_http_info(body, opts = {})

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

@@ -0,0 +1,443 @@
+=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 AccountIntegration289680abbdb24ecc9e55e90a4c2f1770
+    attr_accessor :account_id
+
+    attr_accessor :_alias
+
+    attr_accessor :created_time
+
+    attr_accessor :enabled
+
+    attr_accessor :id
+
+    attr_accessor :integration_status
+
+    attr_accessor :issues
+
+    attr_accessor :last_run
+
+    attr_accessor :saas_id
+
+    attr_accessor :saas_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'account_id',
+        :'_alias' => :'alias',
+        :'created_time' => :'created_time',
+        :'enabled' => :'enabled',
+        :'id' => :'id',
+        :'integration_status' => :'integration_status',
+        :'issues' => :'issues',
+        :'last_run' => :'last_run',
+        :'saas_id' => :'saas_id',
+        :'saas_name' => :'saas_name'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'_alias' => :'String',
+        :'created_time' => :'Time',
+        :'enabled' => :'Boolean',
+        :'id' => :'String',
+        :'integration_status' => :'String',
+        :'issues' => :'Array<Issue9a61d8c8ccac45858497af4786b275c7>',
+        :'last_run' => :'Time',
+        :'saas_id' => :'String',
+        :'saas_name' => :'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::AccountIntegration289680abbdb24ecc9e55e90a4c2f1770` 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::AccountIntegration289680abbdb24ecc9e55e90a4c2f1770`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'_alias')
+        self._alias = attributes[:'_alias']
+      end
+
+      if attributes.key?(:'created_time')
+        self.created_time = attributes[:'created_time']
+      end
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'integration_status')
+        self.integration_status = attributes[:'integration_status']
+      end
+
+      if attributes.key?(:'issues')
+        if (value = attributes[:'issues']).is_a?(Array)
+          self.issues = value
+        end
+      end
+
+      if attributes.key?(:'last_run')
+        self.last_run = attributes[:'last_run']
+      end
+
+      if attributes.key?(:'saas_id')
+        self.saas_id = attributes[:'saas_id']
+      end
+
+      if attributes.key?(:'saas_name')
+        self.saas_name = attributes[:'saas_name']
+      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 @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @_alias.nil?
+        invalid_properties.push('invalid value for "_alias", _alias cannot be nil.')
+      end
+
+      if @_alias.to_s.length < 1
+        invalid_properties.push('invalid value for "_alias", the character length must be great than or equal to 1.')
+      end
+
+      if @created_time.nil?
+        invalid_properties.push('invalid value for "created_time", created_time cannot be nil.')
+      end
+
+      if @enabled.nil?
+        invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @integration_status.nil?
+        invalid_properties.push('invalid value for "integration_status", integration_status cannot be nil.')
+      end
+
+      if @integration_status.to_s.length < 1
+        invalid_properties.push('invalid value for "integration_status", the character length must be great than or equal to 1.')
+      end
+
+      if @issues.nil?
+        invalid_properties.push('invalid value for "issues", issues cannot be nil.')
+      end
+
+      if @last_run.nil?
+        invalid_properties.push('invalid value for "last_run", last_run cannot be nil.')
+      end
+
+      if @saas_id.nil?
+        invalid_properties.push('invalid value for "saas_id", saas_id cannot be nil.')
+      end
+
+      if @saas_id.to_s.length < 1
+        invalid_properties.push('invalid value for "saas_id", the character length must be great than or equal to 1.')
+      end
+
+      if @saas_name.nil?
+        invalid_properties.push('invalid value for "saas_name", saas_name cannot be nil.')
+      end
+
+      if @saas_name.to_s.length < 1
+        invalid_properties.push('invalid value for "saas_name", the character length must be great than or equal to 1.')
+      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 @account_id.nil?
+      return false if @_alias.nil?
+      return false if @_alias.to_s.length < 1
+      return false if @created_time.nil?
+      return false if @enabled.nil?
+      return false if @id.nil?
+      return false if @integration_status.nil?
+      return false if @integration_status.to_s.length < 1
+      return false if @issues.nil?
+      return false if @last_run.nil?
+      return false if @saas_id.nil?
+      return false if @saas_id.to_s.length < 1
+      return false if @saas_name.nil?
+      return false if @saas_name.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] _alias Value to be assigned
+    def _alias=(_alias)
+      if _alias.nil?
+        fail ArgumentError, '_alias cannot be nil'
+      end
+
+      if _alias.to_s.length < 1
+        fail ArgumentError, 'invalid value for "_alias", the character length must be great than or equal to 1.'
+      end
+
+      @_alias = _alias
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] integration_status Value to be assigned
+    def integration_status=(integration_status)
+      if integration_status.nil?
+        fail ArgumentError, 'integration_status cannot be nil'
+      end
+
+      if integration_status.to_s.length < 1
+        fail ArgumentError, 'invalid value for "integration_status", the character length must be great than or equal to 1.'
+      end
+
+      @integration_status = integration_status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] saas_id Value to be assigned
+    def saas_id=(saas_id)
+      if saas_id.nil?
+        fail ArgumentError, 'saas_id cannot be nil'
+      end
+
+      if saas_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "saas_id", the character length must be great than or equal to 1.'
+      end
+
+      @saas_id = saas_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] saas_name Value to be assigned
+    def saas_name=(saas_name)
+      if saas_name.nil?
+        fail ArgumentError, 'saas_name cannot be nil'
+      end
+
+      if saas_name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "saas_name", the character length must be great than or equal to 1.'
+      end
+
+      @saas_name = saas_name
+    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 &&
+          account_id == o.account_id &&
+          _alias == o._alias &&
+          created_time == o.created_time &&
+          enabled == o.enabled &&
+          id == o.id &&
+          integration_status == o.integration_status &&
+          issues == o.issues &&
+          last_run == o.last_run &&
+          saas_id == o.saas_id &&
+          saas_name == o.saas_name
+    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
+      [account_id, _alias, created_time, enabled, id, integration_status, issues, last_run, saas_id, saas_name].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