crimson-falcon 0.4.1 → 1.0.0

data/spec/api/runtime_detections_api_spec.rb

@@ -1,66 +0,0 @@
-=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::RuntimeDetectionsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'RuntimeDetectionsApi' do
-  before do
-    # run before each test
-    @api_instance = Falcon::RuntimeDetectionsApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of RuntimeDetectionsApi' do
-    it 'should create an instance of RuntimeDetectionsApi' do
-      expect(@api_instance).to be_instance_of(Falcon::RuntimeDetectionsApi)
-    end
-  end
-
-  # unit tests for get_runtime_detections_combined_v2
-  # Retrieve container runtime detections by the provided search criteria
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :filter Filter Container Runtime Detections using a query in Falcon Query Language (FQL). Supported filters:  action_taken,aid,cid,cloud,cluster_name,command_line,computer_name,container_id,detect_timestamp,detection_description,detection_id,file_name,file_path,host_id,host_type,image_id,name,namespace,pod_name,severity,tactic
-  # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
-  # @option opts [Integer] :offset The offset from where to begin.
-  # @option opts [String] :sort The field to sort the records on.
-  # @return [RuntimedetectionsDetectionsEntityResponse]
-  describe 'get_runtime_detections_combined_v2 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/sample_uploads_api_spec.rb

@@ -1,191 +0,0 @@
-=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::SampleUploadsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'SampleUploadsApi' do
-  before do
-    # run before each test
-    @api_instance = Falcon::SampleUploadsApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of SampleUploadsApi' do
-    it 'should create an instance of SampleUploadsApi' do
-      expect(@api_instance).to be_instance_of(Falcon::SampleUploadsApi)
-    end
-  end
-
-  # unit tests for archive_delete_v1
-  # Delete an archive that was uploaded previously
-  # @param id The archive SHA256.
-  # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'archive_delete_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 archive_get_v1
-  # Retrieves the archives upload operation statuses. Status `done` means that archive was processed successfully. Status `error` means that archive was not processed successfully.
-  # @param id The archive SHA256.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :include_files If `true` includes processed archive files in response.
-  # @return [ClientArchiveCreateResponseV1]
-  describe 'archive_get_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 archive_list_v1
-  # Retrieves the archives files in chunks.
-  # @param id The archive SHA256.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :limit Max number of files to retrieve.
-  # @option opts [String] :offset Offset from where to get files.
-  # @return [ClientArchiveListFilesResponseV1]
-  describe 'archive_list_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 archive_upload_v1
-  # Uploads an archive and extracts files list from it. Operation is asynchronous use `/archives/entities/archives/v1` to check the status. After uploading, use `/archives/entities/extractions/v1` to copy the file to internal storage making it available for content analysis. This method is deprecated in favor of `/archives/entities/archives/v2`
-  # @param name Name of the archive.
-  # @param body Content of the uploaded archive in binary format. For example, use `--data-binary @$FILE_PATH` when using cURL. Max file size: 100 MB.  Accepted file formats:  - Portable executables: `.zip`, `.7z`.
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :password Archive password.
-  # @option opts [Boolean] :is_confidential Defines visibility of this file, either via the API or the Falcon console.  - `true`: File is only shown to users within your customer account - `false`: File can be seen by other CrowdStrike customers   Default: `true`.
-  # @option opts [String] :comment A descriptive comment to identify the file for other users.
-  # @return [ClientArchiveCreateResponseV1]
-  describe 'archive_upload_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 archive_upload_v2
-  # Uploads an archive and extracts files list from it. Operation is asynchronous use `/archives/entities/archives/v1` to check the status. After uploading, use `/archives/entities/extractions/v1` to copy the file to internal storage making it available for content analysis.
-  # @param file Content of the uploaded archive. For example, use `--form file=@$FILE_PATH;type=` when using cURL. Supported file types are `application/zip` and `application/x-7z-compressed`.
-  # @param name Name of the archive. For example, use `--form name=` when using cURL.
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :password Archive password. For example, use `--form password=` when using cURL.
-  # @option opts [Boolean] :is_confidential Defines visibility of this file in Falcon MalQuery, either via the API or the Falcon console. For example, use `--form is_confidential=` when using cURL.  - `true`: File is only shown to users within your customer account - `false`: File can be seen by other CrowdStrike customers   Default: `true`.
-  # @option opts [String] :comment A descriptive comment to identify the file for other users. For example, use `--form comment=` when using cURL.
-  # @return [ClientArchiveCreateResponseV1]
-  describe 'archive_upload_v2 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_sample_v3
-  # Removes a sample, including file, meta and submissions from the collection
-  # @param ids The file SHA256.
-  # @param [Hash] opts the optional parameters
-  # @return [MsaQueryResponse]
-  describe 'delete_sample_v3 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 extraction_create_v1
-  # Extracts files from an uploaded archive and copies them to internal storage making it available for content analysis.
-  # @param body
-  # @param [Hash] opts the optional parameters
-  # @return [ClientExtractionCreateResponseV1]
-  describe 'extraction_create_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 extraction_get_v1
-  # Retrieves the files extraction operation statuses. Status `done` means that all files were processed successfully. Status `error` means that at least one of the file could not be processed.
-  # @param id The extraction operation ID.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :include_files If `true` includes processed archive files in response.
-  # @return [ClientExtractionCreateResponseV1]
-  describe 'extraction_get_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 extraction_list_v1
-  # Retrieves the files extractions in chunks. Status `done` means that all files were processed successfully. Status `error` means that at least one of the file could not be processed.
-  # @param id The extraction operation ID.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :limit Max number of file extractions to retrieve.
-  # @option opts [String] :offset Offset from where to get file extractions.
-  # @return [ClientExtractionListFilesResponseV1]
-  describe 'extraction_list_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 get_sample_v3
-  # Retrieves the file associated with the given ID (SHA256)
-  # @param ids The file SHA256.
-  # @param [Hash] opts the optional parameters
-  # @option opts [Boolean] :password_protected Flag whether the sample should be zipped and password protected with pass='infected'
-  # @return [String]
-  describe 'get_sample_v3 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 upload_sample_v3
-  # Upload a file for further cloud analysis. After uploading, call the specific analysis API endpoint.
-  # @param sample Content of the uploaded sample in binary format. For example, use `--data-binary @$FILE_PATH` when using cURL. Max file size: 256 MB.  Accepted file formats:  - Portable executables: `.exe`, `.scr`, `.pif`, `.dll`, `.com`, `.cpl`, etc. - Office documents: `.doc`, `.docx`, `.ppt`, `.pps`, `.pptx`, `.ppsx`, `.xls`, `.xlsx`, `.rtf`, `.pub` - PDF - APK - Executable JAR - Windows script component: `.sct` - Windows shortcut: `.lnk` - Windows help: `.chm` - HTML application: `.hta` - Windows script file: `.wsf` - Javascript: `.js` - Visual Basic: `.vbs`,  `.vbe` - Shockwave Flash: `.swf` - Perl: `.pl` - Powershell: `.ps1`, `.psd1`, `.psm1` - Scalable vector graphics: `.svg` - Python: `.py` - Linux ELF executables - Email files: MIME RFC 822 `.eml`, Outlook `.msg`.
-  # @param file_name Name of the file.
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :comment A descriptive comment to identify the file for other users.
-  # @option opts [Boolean] :is_confidential Defines visibility of this file in Falcon MalQuery, either via the API or the Falcon console.  - `true`: File is only shown to users within your customer account - `false`: File can be seen by other CrowdStrike customers   Default: `true`.
-  # @return [ClientSampleMetadataResponseV2]
-  describe 'upload_sample_v3 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/scheduled_reports_api_spec.rb

@@ -1,89 +0,0 @@
-=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::ScheduledReportsApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'ScheduledReportsApi' do
-  before do
-    # run before each test
-    @api_instance = Falcon::ScheduledReportsApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of ScheduledReportsApi' do
-    it 'should create an instance of ScheduledReportsApi' do
-      expect(@api_instance).to be_instance_of(Falcon::ScheduledReportsApi)
-    end
-  end
-
-  # unit tests for scheduled_reports_get
-  # Retrieve scheduled reports for the provided report IDs.
-  # @param ids The scheduled_report id to get details about.
-  # @param [Hash] opts the optional parameters
-  # @return [DomainScheduledReportsResultV1]
-  describe 'scheduled_reports_get 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 scheduled_reports_launch
-  # Launch scheduled reports executions for the provided report IDs.
-  # @param body
-  # @param [Hash] opts the optional parameters
-  # @return [DomainReportExecutionsResponseV1]
-  describe 'scheduled_reports_launch 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 scheduled_reports_query
-  # Find all report IDs matching the query with filter
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :sort Possible order by fields: created_on, last_updated_on, last_execution_on, next_execution_on
-  # @option opts [String] :filter FQL query specifying the filter parameters. Filter term criteria: type, trigger_reference, recipients, user_uuid, cid, trigger_params.metadata. Filter range criteria: created_on, modified_on; use any common date format, such as '2010-05-15T14:55:21.892315096Z'.
-  # @option opts [String] :q Match query criteria, which includes all the filter string fields
-  # @option opts [String] :offset Starting index of overall result set from which to return ids.
-  # @option opts [Integer] :limit Number of ids to return.
-  # @return [MsaQueryResponse]
-  describe 'scheduled_reports_query 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/sensor_download_api_spec.rb

@@ -1,112 +0,0 @@
-=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::SensorDownloadApi
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe 'SensorDownloadApi' do
-  before do
-    # run before each test
-    @api_instance = Falcon::SensorDownloadApi.new
-  end
-
-  after do
-    # run after each test
-  end
-
-  describe 'test an instance of SensorDownloadApi' do
-    it 'should create an instance of SensorDownloadApi' do
-      expect(@api_instance).to be_instance_of(Falcon::SensorDownloadApi)
-    end
-  end
-
-  # unit tests for download_sensor_installer_by_id
-  # Download sensor installer by SHA256 ID
-  # @param id SHA256 of the installer to download
-  # @param [Hash] opts the optional parameters
-  # @return [Object]
-  describe 'download_sensor_installer_by_id 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 get_combined_sensor_installers_by_query
-  # Get sensor installer details by provided query
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :offset The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.
-  # @option opts [Integer] :limit The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results.
-  # @option opts [String] :sort Sort items using their properties. Common sort options include:  <ul><li>version|asc</li><li>release_date|desc</li></ul>
-  # @option opts [String] :filter Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results.  Common filter options include: <ul><li>platform:\"windows\"</li><li>version:>\"5.2\"</li></ul>
-  # @return [DomainSensorInstallersV1]
-  describe 'get_combined_sensor_installers_by_query 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 get_sensor_installers_by_query
-  # Get sensor installer IDs by provided query
-  # @param [Hash] opts the optional parameters
-  # @option opts [Integer] :offset The first item to return, where 0 is the latest item. Use with the limit parameter to manage pagination of results.
-  # @option opts [Integer] :limit The number of items to return in this response (default: 100, max: 500). Use with the offset parameter to manage pagination of results.
-  # @option opts [String] :sort Sort items using their properties. Common sort options include:  <ul><li>version|asc</li><li>release_date|desc</li></ul>
-  # @option opts [String] :filter Filter items using a query in Falcon Query Language (FQL). An asterisk wildcard * includes all results.  Common filter options include: <ul><li>platform:\"windows\"</li><li>version:>\"5.2\"</li></ul>
-  # @return [MsaspecQueryResponse]
-  describe 'get_sensor_installers_by_query 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 get_sensor_installers_ccidby_query
-  # Get CCID to use with sensor installers
-  # @param [Hash] opts the optional parameters
-  # @return [MsaspecQueryResponse]
-  describe 'get_sensor_installers_ccidby_query 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 get_sensor_installers_entities
-  # Get sensor installer details by provided SHA256 IDs
-  # @param ids The IDs of the installers
-  # @param [Hash] opts the optional parameters
-  # @return [DomainSensorInstallersV1]
-  describe 'get_sensor_installers_entities test' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-end