crimson-falcon 0.1.2 → 0.2.0

data/spec/api/quarantine_api_spec.rb

@@ -67,7 +67,7 @@ describe 'QuarantineApi' do
 
   # unit tests for get_aggregate_files
   # Get quarantine file aggregates as specified via json in request body.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [MsaAggregatesResponse]
   describe 'get_aggregate_files test' do
@@ -78,7 +78,7 @@ describe 'QuarantineApi' do
 
   # unit tests for get_quarantine_files
   # Get quarantine file metadata for specified ids.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainMsaQfResponse]
   describe 'get_quarantine_files test' do
@@ -104,7 +104,7 @@ describe 'QuarantineApi' do
 
   # unit tests for update_qf_by_query
   # Apply quarantine file actions by query.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [MsaReplyMetaOnly]
   describe 'update_qf_by_query test' do
@@ -115,7 +115,7 @@ describe 'QuarantineApi' do
 
   # unit tests for update_quarantined_detects_by_ids
   # Apply action by quarantine file ids
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [MsaReplyMetaOnly]
   describe 'update_quarantined_detects_by_ids test' do

data/spec/api/quick_scan_api_spec.rb

@@ -67,7 +67,7 @@ describe 'QuickScanApi' do
 
   # unit tests for get_scans_aggregates
   # Get scans aggregations as specified via json in request body.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [nil]
   describe 'get_scans_aggregates test' do

data/spec/api/real_time_response_admin_api_spec.rb

@@ -60,7 +60,7 @@ describe 'RealTimeResponseAdminApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :timeout Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes.
   # @option opts [String] :timeout_duration Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes.
-  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. 
+  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`.
   # @return [DomainMultiCommandExecuteResponseWrapper]
   describe 'batch_admin_cmd test' do
     it 'should work' do
@@ -226,7 +226,7 @@ describe 'RealTimeResponseAdminApi' do
   # @option opts [String] :comments_for_audit_log The audit log comment
   # @option opts [String] :permission_type Permission for the custom-script. Valid permission values:   - `private`, usable by only the user who uploaded it   - `group`, usable by all RTR Admins   - `public`, usable by all active-responders and RTR admins
   # @option opts [String] :content The script text that you want to use to upload
-  # @option opts [Array<String>] :platform Platforms for the file. Currently supports: windows, mac, linux, 
+  # @option opts [Array<String>] :platform Platforms for the file. Currently supports: windows, mac, linux,
   # @return [MsaReplyMetaOnly]
   describe 'r_tr_update_scripts test' do
     it 'should work' do

data/spec/api/real_time_response_api_spec.rb

@@ -60,7 +60,7 @@ describe 'RealTimeResponseApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :timeout Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes.
   # @option opts [String] :timeout_duration Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes.
-  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. 
+  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`.
   # @return [DomainMultiCommandExecuteResponseWrapper]
   describe 'batch_active_responder_cmd test' do
     it 'should work' do
@@ -74,7 +74,7 @@ describe 'RealTimeResponseApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :timeout Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes.
   # @option opts [String] :timeout_duration Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes.
-  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. 
+  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`.
   # @return [DomainMultiCommandExecuteResponseWrapper]
   describe 'batch_cmd test' do
     it 'should work' do
@@ -88,7 +88,7 @@ describe 'RealTimeResponseApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :timeout Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes.
   # @option opts [String] :timeout_duration Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes.
-  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. 
+  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`.
   # @return [DomainBatchGetCommandResponse]
   describe 'batch_get_cmd test' do
     it 'should work' do
@@ -115,7 +115,7 @@ describe 'RealTimeResponseApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :timeout Timeout for how long to wait for the request in seconds, default timeout is 30 seconds. Maximum is 5 minutes.
   # @option opts [String] :timeout_duration Timeout duration for how long to wait for the request in duration syntax. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. Maximum is 5 minutes.
-  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`. 
+  # @option opts [String] :host_timeout_duration Timeout duration for how long a host has time to complete processing. Default value is a bit less than the overall timeout value. It cannot be greater than the overall request timeout. Maximum is < 5 minutes. Example, `10s`. Valid units: `ns, us, ms, s, m, h`.
   # @return [DomainBatchInitSessionResponse]
   describe 'batch_init_sessions test' do
     it 'should work' do

data/spec/api/recon_api_spec.rb

@@ -56,7 +56,7 @@ describe 'ReconApi' do
 
   # unit tests for aggregate_notifications_exposed_data_records_v1
   # Get notification exposed data record aggregates as specified via JSON in request body. The valid aggregation fields are: [cid notification_id created_date rule.id rule.name rule.topic source_category site author file.name]
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainAggregatesResponse]
   describe 'aggregate_notifications_exposed_data_records_v1 test' do
@@ -67,7 +67,7 @@ describe 'ReconApi' do
 
   # unit tests for aggregate_notifications_v1
   # Get notification aggregates as specified via JSON in request body.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainAggregatesResponse]
   describe 'aggregate_notifications_v1 test' do
@@ -78,7 +78,7 @@ describe 'ReconApi' do
 
   # unit tests for create_actions_v1
   # Create actions for a monitoring rule. Accepts a list of actions that will be attached to the monitoring rule.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainActionEntitiesResponseV1]
   describe 'create_actions_v1 test' do
@@ -89,7 +89,7 @@ describe 'ReconApi' do
 
   # unit tests for create_export_jobs_v1
   # Launch asynchronous export job. Use the job ID to poll the status of the job using GET /entities/exports/v1.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainLaunchExportJobResponseV1]
   describe 'create_export_jobs_v1 test' do
@@ -100,7 +100,7 @@ describe 'ReconApi' do
 
   # unit tests for create_rules_v1
   # Create monitoring rules.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainRulesEntitiesResponseV1]
   describe 'create_rules_v1 test' do
@@ -255,7 +255,7 @@ describe 'ReconApi' do
 
   # unit tests for preview_rule_v1
   # Preview rules notification count and distribution. This will return aggregations on: channel, count, site.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainAggregatesResponse]
   describe 'preview_rule_v1 test' do
@@ -326,7 +326,7 @@ describe 'ReconApi' do
 
   # unit tests for update_action_v1
   # Update an action for a monitoring rule.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainActionEntitiesResponseV1]
   describe 'update_action_v1 test' do
@@ -337,7 +337,7 @@ describe 'ReconApi' do
 
   # unit tests for update_notifications_v1
   # Update notification status or assignee. Accepts bulk requests
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainNotificationEntitiesResponseV1]
   describe 'update_notifications_v1 test' do
@@ -348,7 +348,7 @@ describe 'ReconApi' do
 
   # unit tests for update_rules_v1
   # Update monitoring rules.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainRulesEntitiesResponseV1]
   describe 'update_rules_v1 test' do

data/spec/api/report_executions_api_spec.rb

@@ -93,7 +93,7 @@ describe 'ReportExecutionsApi' do
 
   # unit tests for report_executions_retry
   # This endpoint will be used to retry report executions
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainReportExecutionsResponseV1]
   describe 'report_executions_retry test' do

data/spec/api/response_policies_api_spec.rb

@@ -56,7 +56,7 @@ describe 'ResponsePoliciesApi' do
 
   # unit tests for create_rt_response_policies
   # Create Response Policies by specifying details about the policy to create
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [RemoteResponseRespV1]
   describe 'create_rt_response_policies test' do
@@ -90,7 +90,7 @@ describe 'ResponsePoliciesApi' do
   # unit tests for perform_rt_response_policies_action
   # Perform the specified action on the Response Policies specified in the request
   # @param action_name The action to perform
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [RemoteResponseRespV1]
   describe 'perform_rt_response_policies_action test' do
@@ -159,7 +159,7 @@ describe 'ResponsePoliciesApi' do
 
   # unit tests for set_rt_response_policies_precedence
   # Sets the precedence of Response Policies based on the order of IDs specified in the request. The first ID specified will have the highest precedence and the last ID specified will have the lowest. You must specify all non-Default Policies for a platform when updating precedence
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [MsaQueryResponse]
   describe 'set_rt_response_policies_precedence test' do
@@ -170,7 +170,7 @@ describe 'ResponsePoliciesApi' do
 
   # unit tests for update_rt_response_policies
   # Update Response Policies by specifying the ID of the policy and details to update
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [RemoteResponseRespV1]
   describe 'update_rt_response_policies test' do

data/spec/api/sample_uploads_api_spec.rb

@@ -133,7 +133,7 @@ describe 'SampleUploadsApi' do
 
   # 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 body
   # @param [Hash] opts the optional parameters
   # @return [ClientExtractionCreateResponseV1]
   describe 'extraction_create_v1 test' do

data/spec/api/scheduled_reports_api_spec.rb

@@ -67,7 +67,7 @@ describe 'ScheduledReportsApi' do
 
   # unit tests for scheduled_reports_launch
   # Launch scheduled reports executions for the provided report IDs.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainReportExecutionsResponseV1]
   describe 'scheduled_reports_launch test' do

data/spec/api/sensor_update_policies_api_spec.rb

@@ -56,7 +56,7 @@ describe 'SensorUpdatePoliciesApi' do
 
   # unit tests for create_sensor_update_policies
   # Create Sensor Update Policies by specifying details about the policy to create
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [SensorUpdateRespV1]
   describe 'create_sensor_update_policies test' do
@@ -67,7 +67,7 @@ describe 'SensorUpdatePoliciesApi' do
 
   # unit tests for create_sensor_update_policies_v2
   # Create Sensor Update Policies by specifying details about the policy to create with additional support for uninstall protection
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [SensorUpdateRespV2]
   describe 'create_sensor_update_policies_v2 test' do
@@ -112,7 +112,7 @@ describe 'SensorUpdatePoliciesApi' do
   # unit tests for perform_sensor_update_policies_action
   # Perform the specified action on the Sensor Update Policies specified in the request
   # @param action_name The action to perform
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [SensorUpdateRespV1]
   describe 'perform_sensor_update_policies_action test' do
@@ -234,7 +234,7 @@ describe 'SensorUpdatePoliciesApi' do
 
   # unit tests for reveal_uninstall_token
   # Reveals an uninstall token for a specific device. To retrieve the bulk maintenance token pass the value 'MAINTENANCE' as the value for 'device_id'
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [UninstallTokenRespV1]
   describe 'reveal_uninstall_token test' do
@@ -245,7 +245,7 @@ describe 'SensorUpdatePoliciesApi' do
 
   # unit tests for set_sensor_update_policies_precedence
   # Sets the precedence of Sensor Update Policies based on the order of IDs specified in the request. The first ID specified will have the highest precedence and the last ID specified will have the lowest. You must specify all non-Default Policies for a platform when updating precedence
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [MsaQueryResponse]
   describe 'set_sensor_update_policies_precedence test' do
@@ -256,7 +256,7 @@ describe 'SensorUpdatePoliciesApi' do
 
   # unit tests for update_sensor_update_policies
   # Update Sensor Update Policies by specifying the ID of the policy and details to update
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [SensorUpdateRespV1]
   describe 'update_sensor_update_policies test' do
@@ -267,7 +267,7 @@ describe 'SensorUpdatePoliciesApi' do
 
   # unit tests for update_sensor_update_policies_v2
   # Update Sensor Update Policies by specifying the ID of the policy and details to update with additional support for uninstall protection
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [SensorUpdateRespV2]
   describe 'update_sensor_update_policies_v2 test' do

data/spec/api/sensor_visibility_exclusions_api_spec.rb

@@ -56,7 +56,7 @@ describe 'SensorVisibilityExclusionsApi' do
 
   # unit tests for create_sv_exclusions_v1
   # Create the sensor visibility exclusions
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [ExclusionsRespV1]
   describe 'create_sv_exclusions_v1 test' do
@@ -104,7 +104,7 @@ describe 'SensorVisibilityExclusionsApi' do
 
   # unit tests for update_sensor_visibility_exclusions_v1
   # Update the sensor visibility exclusions
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [SvExclusionsRespV1]
   describe 'update_sensor_visibility_exclusions_v1 test' do

data/spec/api/tailored_intelligence_api_spec.rb

@@ -67,7 +67,7 @@ describe 'TailoredIntelligenceApi' do
 
   # unit tests for get_events_entities
   # Get events entities for specified ids.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainEventEntitiesResponse]
   describe 'get_events_entities test' do
@@ -78,7 +78,7 @@ describe 'TailoredIntelligenceApi' do
 
   # unit tests for get_rules_entities
   # Get rules entities for specified ids.
-  # @param body 
+  # @param body
   # @param [Hash] opts the optional parameters
   # @return [DomainRuleEntitiesResponse]
   describe 'get_rules_entities test' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crimson-falcon
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - CRWD Solution Architects
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -1891,7 +1891,8 @@ files:
 homepage: https://github.com/CrowdStrike/crimson-falcon
 licenses:
 - Unlicense
-metadata: {}
+metadata:
+  documentation_uri: https://github.com/CrowdStrike/crimson-falcon/blob/main/README.md#crimson-falcon-api-docs
 post_install_message: 
 rdoc_options: []
 require_paths: