crimson-falcon 0.4.1 → 1.0.0

data/spec/api/user_management_spec.rb

@@ -0,0 +1,308 @@
+=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::UserManagement
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UserManagement' do
+  before(:all) do
+    # run before each test
+    @api_instance = Falcon::UserManagement.new
+  end
+
+  after(:all) do
+    # run after each test
+  end
+
+  describe 'test an instance of UserManagement' do
+    it 'should create an instance of UserManagement' do
+      expect(@api_instance).to be_instance_of(Falcon::UserManagement)
+    end
+  end
+
+  # unit tests for combined_user_roles_v1
+  # Get User Grant(s). This endpoint lists both direct as well as flight control grants between a User and a Customer.
+  # @param user_uuid User UUID to get available roles for.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cid Customer ID to get grants for. Empty CID would result in Role IDs for user against current CID in view.
+  # @option opts [Boolean] :direct_only Specifies if to request direct Only role grants or all role grants between user and CID (specified in query params)
+  # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: role_id, role_name
+  # @option opts [Integer] :offset The offset to start retrieving records from
+  # @option opts [Integer] :limit The maximum records to return. [1-500]
+  # @option opts [String] :sort The property to sort by
+  # @return [FlightcontrolapiUserGrantResponse]
+  describe 'combined_user_roles_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 create_user
+  # Deprecated : Please use POST /user-management/entities/users/v1. Create a new user. After creating a user, assign one or more roles with POST /user-roles/entities/user-roles/v1
+  # @param body Attributes for this user. `uid` (required) is the user's email address, which is their username in Falcon.  Optional attributes:  <ul><li>`firstName`</li><li>`lastName`</li><li>`password`</li></ul>  As a best practice, we recommend omitting `password`. If single sign-on is enabled for your customer account, the `password` attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no `password`. The user should use the activation email to set their own password.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiUserMetadataResponse]
+  describe 'create_user 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_user_v1
+  # Create a new user. After creating a user, assign one or more roles with POST '/user-management/entities/user-role-actions/v1'
+  # @param body Attributes for this user. `uid` (required) is the user's email address, which is their username in Falcon.  Optional attributes:  <ul><li>`firstName`</li><li>`lastName`</li><li>`password`</li></ul>  As a best practice, we recommend omitting `password`. If single sign-on is enabled for your customer account, the `password` attribute is ignored. If single sign-on is not enabled, we send a user activation request to their email address when you create the user with no `password`. The user should use the activation email to set their own password.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :validate_only Validate of user is allowed, but do not create user.
+  # @return [FlightcontrolapiUserResponse]
+  describe 'create_user_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 delete_user
+  # Deprecated : Please use DELETE /user-management/entities/users/v1. Delete a user permanently
+  # @param user_uuid ID of a user. Find a user's ID from `/users/entities/user/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [MsaReplyMetaOnly]
+  describe 'delete_user 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_user_v1
+  # Delete a user permanently.
+  # @param user_uuid User UUID.
+  # @param [Hash] opts the optional parameters
+  # @return [MsaspecResponseFields]
+  describe 'delete_user_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 entities_roles_v1
+  # Get info about a role
+  # @param ids ID of a role. Find a role ID from `/user-management/queries/roles/v1`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cid Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view.
+  # @return [FlightcontrolapiGetRolesResponse]
+  describe 'entities_roles_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_available_role_ids
+  # Deprecated : Please use GET /user-management/queries/roles/v1. Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [MsaQueryResponse]
+  describe 'get_available_role_ids 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_roles
+  # Deprecated : Please use GET /user-management/entities/roles/v1. Get info about a role
+  # @param ids ID of a role. Find a role ID from `/customer/queries/roles/v1` or `/users/queries/roles/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiUserRoleResponse]
+  describe 'get_roles 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_user_role_ids
+  # Deprecated : Please use GET /user-management/combined/user-roles/v1. Show role IDs of roles assigned to a user. For more information on each role, provide the role ID to `/customer/entities/roles/v1`.
+  # @param user_uuid ID of a user. Find a user's ID from `/users/entities/user/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [MsaQueryResponse]
+  describe 'get_user_role_ids 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 grant_user_role_ids
+  # Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Assign one or more roles to a user
+  # @param user_uuid ID of a user. Find a user's ID from `/users/entities/user/v1`.
+  # @param body Role ID(s) of the role you want to assign
+  # @param [Hash] opts the optional parameters
+  # @return [ApiUserRoleIDsResponse]
+  describe 'grant_user_role_ids 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 queries_roles_v1
+  # Show role IDs for all roles available in your customer account. For more information on each role, provide the role ID to `/user-management/entities/roles/v1`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cid Customer ID to get available roles for. Empty CID would result in Role IDs for current CID in view.
+  # @option opts [String] :user_uuid User UUID to get available roles for. Empty User UUID would returns all roles IDs available for customer.
+  # @option opts [String] :action Actionable purpose of the query
+  # @return [MsaspecQueryResponse]
+  describe 'queries_roles_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 query_user_v1
+  # List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/user-management/entities/users/GET/v1`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter Filter using a query in Falcon Query Language (FQL). Supported filters: assigned_cids, cid, first_name, last_name, name, uid
+  # @option opts [Integer] :offset The offset to start retrieving records from
+  # @option opts [Integer] :limit The maximum records to return. [1-500]
+  # @option opts [String] :sort The property to sort by
+  # @return [MsaspecQueryResponse]
+  describe 'query_user_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 retrieve_emails_by_cid
+  # Deprecated : Please use POST /user-management/entities/users/GET/v1. List the usernames (usually an email address) for all users in your customer account
+  # @param [Hash] opts the optional parameters
+  # @return [MsaQueryResponse]
+  describe 'retrieve_emails_by_cid 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 retrieve_user
+  # Deprecated : Please use POST /user-management/entities/users/GET/v1. Get info about a user
+  # @param ids ID of a user. Find a user's ID from `/users/entities/user/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiUserMetadataResponse]
+  describe 'retrieve_user 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 retrieve_user_uuid
+  # Deprecated : Please use GET /user-management/queries/users/v1. Get a user's ID by providing a username (usually an email address)
+  # @param uid A username. This is usually the user's email address, but may vary based on your configuration.
+  # @param [Hash] opts the optional parameters
+  # @return [MsaQueryResponse]
+  describe 'retrieve_user_uuid 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 retrieve_user_uuids_by_cid
+  # Deprecated : Please use GET /user-management/queries/users/v1. List user IDs for all users in your customer account. For more information on each user, provide the user ID to `/users/entities/user/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [MsaQueryResponse]
+  describe 'retrieve_user_uuids_by_cid 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 retrieve_users_getv1
+  # Get info about users including their name, UID and CID by providing user UUIDs
+  # @param body Maximum of 5000 User UUIDs can be specified per request.
+  # @param [Hash] opts the optional parameters
+  # @return [FlightcontrolapiUserResponse]
+  describe 'retrieve_users_getv1 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 revoke_user_role_ids
+  # Deprecated : Please use POST /user-management/entities/user-role-actions/v1. Revoke one or more roles from a user
+  # @param user_uuid ID of a user. Find a user's ID from `/users/entities/user/v1`.
+  # @param ids One or more role IDs to revoke. Find a role's ID from `/users/queries/roles/v1`.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiUserRoleIDsResponse]
+  describe 'revoke_user_role_ids 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_user
+  # Deprecated : Please use PATCH /user-management/entities/users/v1. Modify an existing user's first or last name
+  # @param user_uuid ID of a user. Find a user's ID from `/users/entities/user/v1`.
+  # @param body Attributes for this user. All attributes (shown below) are optional.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiUserMetadataResponse]
+  describe 'update_user 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_user_v1
+  # Modify an existing user's first or last name.
+  # @param user_uuid user uuid
+  # @param body Both firstName and lastName have to specified.
+  # @param [Hash] opts the optional parameters
+  # @return [FlightcontrolapiUserResponse]
+  describe 'update_user_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 user_action_v1
+  # Apply actions to one or more User. Available action names: reset_2fa, reset_password. User UUIDs can be provided in `ids` param as part of request payload.
+  # @param body User UUIDs and Action Name params are required. Allowed values for Action Name param includes 'reset_2fa' and 'reset_password'
+  # @param [Hash] opts the optional parameters
+  # @return [MsaspecResponseFields]
+  describe 'user_action_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 user_roles_action_v1
+  # 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 All fields including 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]
+  describe 'user_roles_action_v1 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/vulnerabilities_spec.rb

@@ -0,0 +1,66 @@
+=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::Vulnerabilities
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Vulnerabilities' do
+  before(:all) do
+    # run before each test
+    @api_instance = Falcon::Vulnerabilities.new
+  end
+
+  after(:all) do
+    # run after each test
+  end
+
+  describe 'test an instance of Vulnerabilities' do
+    it 'should create an instance of Vulnerabilities' do
+      expect(@api_instance).to be_instance_of(Falcon::Vulnerabilities)
+    end
+  end
+
+  # unit tests for get_combined_vulnerabilities_sarif
+  # Retrieve all lambda vulnerabilities that match the given query and return in the SARIF format
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter Filter lambda vulnerabilities using a query in Falcon Query Language (FQL).Supported filters:  application_name,application_name_version,cid,cloud_account_id,cloud_account_name,cloud_provider,cve_id,cvss_base_score,exprt_rating,first_seen_timestamp,function_name,function_resource_id,is_supported,is_valid_asset_id,layer,region,runtime,severity,timestamp,type
+  # @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 fields to sort the records on. Supported columns:  [application_name application_name_version cid cloud_account_id cloud_account_name cloud_provider cve_id cvss_base_score exprt_rating first_seen_timestamp function_resource_id is_supported layer region runtime severity timestamp type]
+  # @return [VulnerabilitiesVulnerabilityEntitySARIFResponse]
+  describe 'get_combined_vulnerabilities_sarif 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/workflows_spec.rb

@@ -0,0 +1,274 @@
+=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::Workflows
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Workflows' do
+  before(:all) do
+    # run before each test
+    @api_instance = Falcon::Workflows.new
+  end
+
+  after(:all) do
+    # run after each test
+  end
+
+  describe 'test an instance of Workflows' do
+    it 'should create an instance of Workflows' do
+      expect(@api_instance).to be_instance_of(Falcon::Workflows)
+    end
+  end
+
+  # unit tests for workflow_activities_combined
+  # Search for activities by name. Returns all supported activities if no filter specified
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter FQL query specifying filter parameters.
+  # @option opts [String] :offset Starting pagination offset of records to return.
+  # @option opts [Integer] :limit Maximum number of records to return.
+  # @option opts [String] :sort Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
+  # @return [ActivitiesActivityExternalResponse]
+  describe 'workflow_activities_combined 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 workflow_definitions_combined
+  # Search workflow definitions based on the provided filter
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter FQL query specifying filter parameters.
+  # @option opts [String] :offset Starting pagination offset of records to return.
+  # @option opts [Integer] :limit Maximum number of records to return.
+  # @option opts [String] :sort Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
+  # @return [DefinitionsDefinitionExternalResponse]
+  describe 'workflow_definitions_combined 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 workflow_definitions_export
+  # Exports a workflow definition for the given definition ID
+  # @param id ID of workflow definitions to return details for
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :sanitize whether or not to sanitize PII from workflow before it's exported
+  # @return [Array<Integer>]
+  describe 'workflow_definitions_export 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 workflow_definitions_import
+  # Imports a workflow definition based on the provided model
+  # @param data_file A workflow definition in YAML format to import
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :name Workflow name to override
+  # @option opts [Boolean] :validate_only When enabled, prevents saving workflow after validating
+  # @return [DefinitionsDefinitionImportResponse]
+  describe 'workflow_definitions_import 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 workflow_definitions_update
+  # Updates a workflow definition based on the provided model
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :validate_only When enabled, prevents saving workflow after validating
+  # @return [ApiResourceIDsResponse]
+  describe 'workflow_definitions_update 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 workflow_execute
+  # Executes an on-demand Workflow, the body is JSON used to trigger the execution, the response the execution ID(s)
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :execution_cid CID(s) to execute on. This can be a child if this is a flight control enabled definition. If unset the definition CID is used.
+  # @option opts [Array<String>] :definition_id Definition ID to execute, either a name or an ID can be specified.
+  # @option opts [String] :name Workflow name to execute, either a name or an ID can be specified.
+  # @option opts [String] :key Key used to help deduplicate executions, if unset a new UUID is used
+  # @option opts [Integer] :depth Used to record the execution depth to help limit execution loops when a workflow triggers another. The maximum depth is 4.
+  # @option opts [String] :source_event_url Used to record a URL to the source that led to triggering this workflow
+  # @return [ApiResourceIDsResponse]
+  describe 'workflow_execute 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 workflow_execute_internal
+  # Executes an on-demand Workflow - internal workflows permitted, the body is JSON used to trigger the execution, the response the execution ID(s)
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :execution_cid CID(s) to execute on. This can be a child if this is a flight control enabled definition. If unset the definition CID is used.
+  # @option opts [Array<String>] :definition_id Definition ID to execute, either a name or an ID can be specified.
+  # @option opts [String] :name Workflow name to execute, either a name or an ID can be specified.
+  # @option opts [String] :key Key used to help deduplicate executions, if unset a new UUID is used
+  # @option opts [Integer] :depth Used to record the execution depth to help limit execution loops when a workflow triggers another. The maximum depth is 4.
+  # @option opts [Integer] :batch_size Used to set the batchSize, if unset the default batchSize is used
+  # @option opts [String] :source_event_url Used to record a URL to the source that led to triggering this workflow
+  # @return [ApiResourceIDsResponse]
+  describe 'workflow_execute_internal 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 workflow_execution_results
+  # Get execution result of a given execution
+  # @param ids workflow execution id to return results for.
+  # @param [Hash] opts the optional parameters
+  # @return [ApiExecutionResultsResponse]
+  describe 'workflow_execution_results 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 workflow_executions_action
+  # Allows a user to resume/retry a failed workflow execution.
+  # @param action_name Specify one of these actions:  - &#x60;resume&#x60;: resume/retry the workflow execution(s) specified in ids
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [DefinitionsDefinitionEntitiesResponse]
+  describe 'workflow_executions_action 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 workflow_executions_combined
+  # Search workflow executions based on the provided filter
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter FQL query specifying filter parameters.
+  # @option opts [String] :offset Starting pagination offset of records to return.
+  # @option opts [Integer] :limit Maximum number of records to return.
+  # @option opts [String] :sort Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
+  # @return [ApiExecutionResultsResponse]
+  describe 'workflow_executions_combined 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 workflow_get_human_input_v1
+  # Gets one or more specific human inputs by their IDs.
+  # @param ids IDs of human inputs to read
+  # @param [Hash] opts the optional parameters
+  # @return [ModelUserInputReadResponse]
+  describe 'workflow_get_human_input_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 workflow_mock_execute
+  # Executes a workflow definition with mocks
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @option opts [Array<String>] :execution_cid CID(s) to execute on. This can be a child if this is a flight control enabled definition. If unset the definition CID is used.
+  # @option opts [String] :definition_id Definition ID to execute, either a name or an ID, or the definition itself in the request body, can be specified.
+  # @option opts [String] :name Workflow name to execute, either a name or an ID, or the definition itself in the request body, can be specified.
+  # @option opts [String] :key Key used to help deduplicate executions, if unset a new UUID is used
+  # @option opts [Integer] :depth Used to record the execution depth to help limit execution loops when a workflow triggers another. The maximum depth is 4.
+  # @option opts [String] :source_event_url Used to record a URL to the source that led to triggering this workflow
+  # @option opts [Boolean] :validate_only When enabled, prevents execution after validating mocks against definition
+  # @return [ApiResourceIDsResponse]
+  describe 'workflow_mock_execute 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 workflow_system_definitions_de_provision
+  # Deprovisions a system definition that was previously provisioned on the target CID
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ClientSystemDefinitionCreateResponse]
+  describe 'workflow_system_definitions_de_provision 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 workflow_system_definitions_promote
+  # Promotes a version of a system definition for a customer. The customer must already have been provisioned. This allows the caller to apply an updated template version to a specific cid and expects all parameters to be supplied. If the template supports multi-instance the customer scope definition ID must be supplied to determine which customer workflow should be updated.
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ClientSystemDefinitionCreateResponse]
+  describe 'workflow_system_definitions_promote 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 workflow_system_definitions_provision
+  # Provisions a system definition onto the target CID by using the template and provided parameters
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ClientSystemDefinitionCreateResponse]
+  describe 'workflow_system_definitions_provision 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 workflow_triggers_combined
+  # Search for triggers by namespaced identifier, i.e. FalconAudit, Detection, or FalconAudit/Detection/Status. Returns all triggers if no filter specified
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :filter FQL query specifying filter parameters.
+  # @return [TriggersTriggerExternalResponse]
+  describe 'workflow_triggers_combined 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 workflow_update_human_input_v1
+  # Provides an input in response to a human input action. Depending on action configuration, one or more of Approve, Decline, and/or Escalate are permitted.
+  # @param id ID of human input to provide an input to
+  # @param body
+  # @param [Hash] opts the optional parameters
+  # @return [ApiResourceIDsResponse]
+  describe 'workflow_update_human_input_v1 test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end