crimson-falcon 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8dc3a326f3893415bf6c84e09ffd284128b1796ef4dd6a64b7c6a1f23be561b
-  data.tar.gz: 503a4b63cf17dbb568856a452f61ce99e52a7825d01034fdeb31bf22d7cb7ec0
+  metadata.gz: 23fe5591eb6440276364a1c387bf0ce4efc47ef77f326c114be55ae316d7348f
+  data.tar.gz: 52a22f0833db82cb3cfdbae850b1735930928b4cbc3ef5084aced01da8180388
 SHA512:
-  metadata.gz: 1a91e00b40fd3ecc55c261ab0c2800bf6721ba87922140be16307fefa5b3ed0ca311e03b122d80d106fbd8b45f5e14e524cd12eb703cf932279c1bc329109e9b
-  data.tar.gz: 2106b5de756b9c5871c1ab7b953ff57a8346155278563854f9d4438ea1febb8c4f62f2b21f215dd642357032c702889ecc83a5559e1368b657cd034438f8ffb6
+  metadata.gz: 79061ce89fe3a180a6f57ef1c54eb82ddd0db37b8b20160fd21d96dc0d26bb96f61800b356a0f59b7db2973d9dfe80528d07eb5040500d2cd8251db30d884924
+  data.tar.gz: 0eb95c801c35925419076362d09d708c2b3ab61acbe5c35227a52faa03b46609bde9061cc3853fa03e845fc7f79607aa1e9efa96c98c131f80af5d5c5bf196a4

data/README.md

@@ -31,7 +31,7 @@ gem install crimson-falcon
 Add this to the Gemfile:
 <!-- x-release-please-start-version -->
 ```ruby
-    gem 'crimson-falcon', '~> 1.3.0'
+    gem 'crimson-falcon', '~> 1.4.0'
 ```
 <!-- x-release-please-end -->
 ### From Source to Gem: Building the Ruby Code
@@ -45,13 +45,13 @@ gem build crimson-falcon.gemspec
 Then install the gem locally:
 <!-- x-release-please-start-version -->
 ```shell
-gem install ./crimson-falcon-1.3.0.gem
+gem install ./crimson-falcon-1.4.0.gem
 ```
 <!-- x-release-please-end -->
 Finally, add this to the Gemfile:
 <!-- x-release-please-start-version -->
 ```ruby
-    gem 'crimson-falcon', '~> 1.3.0'
+    gem 'crimson-falcon', '~> 1.4.0'
 ```
 <!-- x-release-please-end -->
 ### Install from Git

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

@@ -0,0 +1,163 @@
+=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 AccessScopes
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List Access Scopes By ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids
+    # @return [AccessscopemanagerV1ListAccessScopesResponseExternal]
+    def list_access_scopes_external(opts = {})
+      data, _status_code, _headers = list_access_scopes_external_with_http_info(opts)
+      data
+    end
+
+    # List Access Scopes By ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :ids
+    # @return [Array<(AccessscopemanagerV1ListAccessScopesResponseExternal, Integer, Hash)>] AccessscopemanagerV1ListAccessScopesResponseExternal data, response status code and response headers
+    def list_access_scopes_external_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessScopes.list_access_scopes_external ...'
+      end
+      # resource path
+      local_var_path = '/access-scope-management/entities/access-scopes/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ids'] = @api_client.build_collection_param(opts[:'ids'], :multi) if !opts[:'ids'].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] || 'AccessscopemanagerV1ListAccessScopesResponseExternal'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AccessScopes.list_access_scopes_external",
+        :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: AccessScopes#list_access_scopes_external\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query Access Scopes and returns IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter A valid FQL filter. Access Scope fields: name, created_by, created_at.
+    # @option opts [String] :sort
+    # @option opts [Integer] :offset
+    # @option opts [Integer] :limit
+    # @return [AccessscopemanagerV1QueryAccessScopesResponseExternal]
+    def query_access_scopes_external(opts = {})
+      data, _status_code, _headers = query_access_scopes_external_with_http_info(opts)
+      data
+    end
+
+    # Query Access Scopes and returns IDs
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter A valid FQL filter. Access Scope fields: name, created_by, created_at.
+    # @option opts [String] :sort
+    # @option opts [Integer] :offset
+    # @option opts [Integer] :limit
+    # @return [Array<(AccessscopemanagerV1QueryAccessScopesResponseExternal, Integer, Hash)>] AccessscopemanagerV1QueryAccessScopesResponseExternal data, response status code and response headers
+    def query_access_scopes_external_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessScopes.query_access_scopes_external ...'
+      end
+      # resource path
+      local_var_path = '/access-scope-management/queries/access-scopes/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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] || 'AccessscopemanagerV1QueryAccessScopesResponseExternal'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AccessScopes.query_access_scopes_external",
+        :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: AccessScopes#query_access_scopes_external\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,166 @@
+=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 AgentInvocation
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieves the list of of messages that are resulted from the specified invocation
+    # @param id [String] Invocation ID
+    # @param [Hash] opts the optional parameters
+    # @return [ApiInvokeAgentResponse]
+    def get_agent_invocation_v3(id, opts = {})
+      data, _status_code, _headers = get_agent_invocation_v3_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieves the list of of messages that are resulted from the specified invocation
+    # @param id [String] Invocation ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiInvokeAgentResponse, Integer, Hash)>] ApiInvokeAgentResponse data, response status code and response headers
+    def get_agent_invocation_v3_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentInvocation.get_agent_invocation_v3 ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AgentInvocation.get_agent_invocation_v3"
+      end
+      # resource path
+      local_var_path = '/agentic-studio/entities/agent-invocations/v3'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'id'] = id
+
+      # 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] || 'ApiInvokeAgentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AgentInvocation.get_agent_invocation_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: AgentInvocation#get_agent_invocation_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Invoke a published agent by ID with the specified input. Returns the agent's completion response.
+    # @param body [ApiInvokePublishedAgentExternalRequest] Published agent invocation request containing agent ID and input
+    # @param [Hash] opts the optional parameters
+    # @return [ApiInvokeAgentResponse]
+    def invoke_published_agent_external_v1(body, opts = {})
+      data, _status_code, _headers = invoke_published_agent_external_v1_with_http_info(body, opts)
+      data
+    end
+
+    # Invoke a published agent by ID with the specified input. Returns the agent&#39;s completion response.
+    # @param body [ApiInvokePublishedAgentExternalRequest] Published agent invocation request containing agent ID and input
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ApiInvokeAgentResponse, Integer, Hash)>] ApiInvokeAgentResponse data, response status code and response headers
+    def invoke_published_agent_external_v1_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AgentInvocation.invoke_published_agent_external_v1 ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling AgentInvocation.invoke_published_agent_external_v1"
+      end
+      # resource path
+      local_var_path = '/agentic-studio/entities/agent-invocations/v1'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ApiInvokeAgentResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"AgentInvocation.invoke_published_agent_external_v1",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AgentInvocation#invoke_published_agent_external_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end