crimson-falcon 0.3.0 → 0.4.0

data/spec/api/image_assessment_policies_api_spec.rb

@@ -0,0 +1,172 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Falcon::ImageAssessmentPoliciesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'ImageAssessmentPoliciesApi' do
+  before do
+    # run before each test
+    @api_instance = Falcon::ImageAssessmentPoliciesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of ImageAssessmentPoliciesApi' do
+    it 'should create an instance of ImageAssessmentPoliciesApi' do
+      expect(@api_instance).to be_instance_of(Falcon::ImageAssessmentPoliciesApi)
+    end
+  end
+
+  # unit tests for create_policies
+  # Create Image Assessment policies
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyEntityResponse]
+  describe 'create_policies test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_policy_groups
+  # Create Image Assessment Policy Group entities
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyGroupEntityResponse]
+  describe 'create_policy_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_policy
+  # Delete Image Assessment Policy by policy UUID
+  # @param id Image Assessment Policy entity UUID
+  # @param [Hash] opts the optional parameters
+  # @return [CoreEntitiesResponse]
+  describe 'delete_policy test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_policy_group
+  # Delete Image Assessment Policy Group entities
+  # @param id Policy Image Group entity UUID
+  # @param [Hash] opts the optional parameters
+  # @return [CoreEntitiesResponse]
+  describe 'delete_policy_group test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_policies
+  # Get all Image Assessment policies
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyEntityResponse]
+  describe 'read_policies test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_policy_exclusions
+  # Retrieve Image Assessment Policy Exclusion entities
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyExclusionEntityResponse]
+  describe 'read_policy_exclusions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for read_policy_groups
+  # Retrieve Image Assessment Policy Group entities
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyGroupEntityResponse]
+  describe 'read_policy_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_policies
+  # Update Image Assessment Policy entities
+  # @param id Image Assessment Policy entity UUID
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyEntityResponse]
+  describe 'update_policies test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_policy_exclusions
+  # Update Image Assessment Policy Exclusion entities
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyExclusionEntityResponse]
+  describe 'update_policy_exclusions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_policy_groups
+  # Update Image Assessment Policy Group entities
+  # @param id Policy Image Group entity UUID
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyGroupEntityResponse]
+  describe 'update_policy_groups test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_policy_precedence
+  # Update Image Assessment Policy precedence
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ModelsPolicyEntityResponse]
+  describe 'update_policy_precedence test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/installation_tokens_api_spec.rb

@@ -56,7 +56,7 @@ describe 'InstallationTokensApi' do
   # @option opts [Integer] :limit The maximum records to return. [1-1000]. Defaults to 50.
   # @option opts [String] :sort The property to sort by (e.g. timestamp.desc).
   # @option opts [String] :filter The filter expression that should be used to limit the results (e.g., `action:'token_create'`).
-  # @return [MsaQueryResponse]
+  # @return [MsaspecQueryResponse]
   describe 'audit_events_query test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -99,7 +99,7 @@ describe 'InstallationTokensApi' do
   # Deletes a token immediately. To revoke a token, use PATCH /installation-tokens/entities/tokens/v1 instead.
   # @param ids The token ids to delete.
   # @param [Hash] opts the optional parameters
-  # @return [MsaReplyMetaOnly]
+  # @return [MsaspecResponseFields]
   describe 'tokens_delete test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -113,7 +113,7 @@ describe 'InstallationTokensApi' do
   # @option opts [Integer] :limit The maximum records to return. [1-1000]. Defaults to 50.
   # @option opts [String] :sort The property to sort by (e.g. created_timestamp.desc).
   # @option opts [String] :filter The filter expression that should be used to limit the results (e.g., `status:'valid'`).
-  # @return [MsaQueryResponse]
+  # @return [MsaspecQueryResponse]
   describe 'tokens_query test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -136,7 +136,7 @@ describe 'InstallationTokensApi' do
   # @param ids The token ids to update.
   # @param body
   # @param [Hash] opts the optional parameters
-  # @return [MsaQueryResponse]
+  # @return [MsaspecQueryResponse]
   describe 'tokens_update test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/api/installation_tokens_settings_api_spec.rb

@@ -53,7 +53,7 @@ describe 'InstallationTokensSettingsApi' do
   # Update installation token settings.
   # @param body
   # @param [Hash] opts the optional parameters
-  # @return [MsaQueryResponse]
+  # @return [MsaspecQueryResponse]
   describe 'customer_settings_update test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/api/intel_api_spec.rb

@@ -240,7 +240,7 @@ describe 'IntelApi' do
   # @option opts [Integer] :offset Set the starting row number to return reports from. Defaults to 0.
   # @option opts [Integer] :limit Set the number of reports to return. The value must be between 1 and 5000.
   # @option opts [String] :sort Order fields in ascending or descending order. Ex: created_date|asc.
-  # @option opts [String] :filter Filter your query by specifying FQL filter parameters. Filter parameters include:  actors, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.
+  # @option opts [String] :filter Filter your query by specifying FQL filter parameters. Filter parameters include:  actors, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, malware, malware.community_identifiers, malware.family_name, malware.slug, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.
   # @option opts [String] :q Perform a generic substring search across all fields.
   # @option opts [Array<String>] :fields The fields to return, or a predefined set of fields in the form of the collection name surrounded by two underscores like:  \\_\\_\\&lt;collection\\&gt;\\_\\_.  Ex: slug \\_\\_full\\_\\_.  Defaults to \\_\\_basic\\_\\_.
   # @return [DomainNewsResponse]
@@ -256,7 +256,7 @@ describe 'IntelApi' do
   # @option opts [Integer] :offset Set the starting row number to return report IDs from. Defaults to 0.
   # @option opts [Integer] :limit Set the number of report IDs to return. The value must be between 1 and 5000.
   # @option opts [String] :sort Order fields in ascending or descending order.  Ex: created_date|asc.
-  # @option opts [String] :filter Filter your query by specifying FQL filter parameters. Filter parameters include:  actors, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.
+  # @option opts [String] :filter Filter your query by specifying FQL filter parameters. Filter parameters include:  actors, actors.id, actors.name, actors.slug, actors.url, created_date, description, id, last_modified_date, malware, malware.community_identifiers, malware.family_name, malware.slug, motivations, motivations.id, motivations.slug, motivations.value, name, name.raw, short_description, slug, sub_type, sub_type.id, sub_type.name, sub_type.slug, tags, tags.id, tags.slug, tags.value, target_countries, target_countries.id, target_countries.slug, target_countries.value, target_industries, target_industries.id, target_industries.slug, target_industries.value, type, type.id, type.name, type.slug, url.
   # @option opts [String] :q Perform a generic substring search across all fields.
   # @return [MsaQueryResponse]
   describe 'query_intel_report_ids test' do

data/spec/api/ioc_api_spec.rb

@@ -139,6 +139,47 @@ describe 'IocApi' do
     end
   end
 
+  # unit tests for indicator_get_device_count_v1
+  # Get the number of devices the indicator has run on
+  # @param type  The type of the indicator. Valid types include:  sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64.  md5: A hex-encoded md5 hash string. Length - min 32, max: 32.  domain: A domain name. Length - min: 1, max: 200.  ipv4: An IPv4 address. Must be a valid IP address.  ipv6: An IPv6 address. Must be a valid IP address.
+  # @param value The string representation of the indicator
+  # @param [Hash] opts the optional parameters
+  # @return [ApiDeviceCountRespV1]
+  describe 'indicator_get_device_count_v1 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for indicator_get_devices_ran_on_v1
+  # Get the IDs of devices the indicator has run on
+  # @param type  The type of the indicator. Valid types include:  sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64.  md5: A hex-encoded md5 hash string. Length - min 32, max: 32.  domain: A domain name. Length - min: 1, max: 200.  ipv4: An IPv4 address. Must be a valid IP address.  ipv6: An IPv6 address. Must be a valid IP address.
+  # @param value The string representation of the indicator
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :limit The maximum number of results to return. Use with the offset parameter to manage pagination of results.
+  # @option opts [String] :offset The first process to return, where 0 is the latest offset. Use with the limit parameter to manage pagination of results.
+  # @return [ApiDevicesRanOnRespV1]
+  describe 'indicator_get_devices_ran_on_v1 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for indicator_get_processes_ran_on_v1
+  # Get the number of processes the indicator has run on
+  # @param type  The type of the indicator. Valid types include:  sha256: A hex-encoded sha256 hash string. Length - min: 64, max: 64.  md5: A hex-encoded md5 hash string. Length - min 32, max: 32.  domain: A domain name. Length - min: 1, max: 200.  ipv4: An IPv4 address. Must be a valid IP address.  ipv6: An IPv6 address. Must be a valid IP address.
+  # @param value The string representation of the indicator
+  # @param device_id Specify a host's ID to return only processes from that host. Get a host's ID from GET /devices/queries/devices/v1, the Falcon console, or the Streaming API.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :limit The maximum number of results to return. Use with the offset parameter to manage pagination of results.
+  # @option opts [String] :offset The first process to return, where 0 is the latest offset. Use with the limit parameter to manage pagination of results.
+  # @return [ApiProcessesRanOnRespV1]
+  describe 'indicator_get_processes_ran_on_v1 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for indicator_get_v1
   # Get Indicators by ids.
   # @param ids The ids of the Indicators to retrieve