crimson-falcon 0.3.0 → 0.4.1

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

@@ -0,0 +1,365 @@
+=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 ContainerPackagesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieve top x app packages with the most fixable vulnerabilities
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
+    # @option opts [Integer] :offset The offset from where to begin.
+    # @return [PackagesApiPackagesByVulnCount]
+    def read_packages_by_fixable_vuln_count(opts = {})
+      data, _status_code, _headers = read_packages_by_fixable_vuln_count_with_http_info(opts)
+      data
+    end
+
+    # Retrieve top x app packages with the most fixable vulnerabilities
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
+    # @option opts [Integer] :offset The offset from where to begin.
+    # @return [Array<(PackagesApiPackagesByVulnCount, Integer, Hash)>] PackagesApiPackagesByVulnCount data, response status code and response headers
+    def read_packages_by_fixable_vuln_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContainerPackagesApi.read_packages_by_fixable_vuln_count ...'
+      end
+      # resource path
+      local_var_path = '/container-security/combined/packages/app-by-fixable-vulnerability-count/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'PackagesApiPackagesByVulnCount'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContainerPackagesApi.read_packages_by_fixable_vuln_count",
+        :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: ContainerPackagesApi#read_packages_by_fixable_vuln_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve top x packages with the most vulnerabilities
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
+    # @option opts [Integer] :offset The offset from where to begin.
+    # @return [PackagesApiPackagesByVulnCount]
+    def read_packages_by_vuln_count(opts = {})
+      data, _status_code, _headers = read_packages_by_vuln_count_with_http_info(opts)
+      data
+    end
+
+    # Retrieve top x packages with the most vulnerabilities
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Integer] :limit The upper-bound on the number of records to retrieve.
+    # @option opts [Integer] :offset The offset from where to begin.
+    # @return [Array<(PackagesApiPackagesByVulnCount, Integer, Hash)>] PackagesApiPackagesByVulnCount data, response status code and response headers
+    def read_packages_by_vuln_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContainerPackagesApi.read_packages_by_vuln_count ...'
+      end
+      # resource path
+      local_var_path = '/container-security/combined/packages/by-vulnerability-count/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'PackagesApiPackagesByVulnCount'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContainerPackagesApi.read_packages_by_vuln_count",
+        :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: ContainerPackagesApi#read_packages_by_vuln_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve packages identified by the provided filter criteria
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages, default is false
+    # @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:  [license package_name_version type]
+    # @return [PackagesApiCombinedPackage]
+    def read_packages_combined(opts = {})
+      data, _status_code, _headers = read_packages_combined_with_http_info(opts)
+      data
+    end
+
+    # Retrieve packages identified by the provided filter criteria
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages, default is false
+    # @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:  [license package_name_version type]
+    # @return [Array<(PackagesApiCombinedPackage, Integer, Hash)>] PackagesApiCombinedPackage data, response status code and response headers
+    def read_packages_combined_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContainerPackagesApi.read_packages_combined ...'
+      end
+      # resource path
+      local_var_path = '/container-security/combined/packages/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'only_zero_day_affected'] = opts[:'only_zero_day_affected'] if !opts[:'only_zero_day_affected'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'PackagesApiCombinedPackage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContainerPackagesApi.read_packages_combined",
+        :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: ContainerPackagesApi#read_packages_combined\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve packages identified by the provided filter criteria for the purpose of export
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages, default is false
+    # @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:  [license package_name_version type]
+    # @return [PackagesApiCombinedPackageExport]
+    def read_packages_combined_export(opts = {})
+      data, _status_code, _headers = read_packages_combined_export_with_http_info(opts)
+      data
+    end
+
+    # Retrieve packages identified by the provided filter criteria for the purpose of export
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters:  cid,container_id,cveid,fix_status,image_digest,license,package_name_version,severity,type,vulnerability_count
+    # @option opts [Boolean] :only_zero_day_affected (true/false) load zero day affected packages, default is false
+    # @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:  [license package_name_version type]
+    # @return [Array<(PackagesApiCombinedPackageExport, Integer, Hash)>] PackagesApiCombinedPackageExport data, response status code and response headers
+    def read_packages_combined_export_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContainerPackagesApi.read_packages_combined_export ...'
+      end
+      # resource path
+      local_var_path = '/container-security/combined/packages/export/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
+      query_params[:'only_zero_day_affected'] = opts[:'only_zero_day_affected'] if !opts[:'only_zero_day_affected'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].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] || 'PackagesApiCombinedPackageExport'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContainerPackagesApi.read_packages_combined_export",
+        :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: ContainerPackagesApi#read_packages_combined_export\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve packages count affected by zero day vulnerabilities
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid
+    # @return [CommonCountResponse]
+    def read_packages_count_by_zero_day(opts = {})
+      data, _status_code, _headers = read_packages_count_by_zero_day_with_http_info(opts)
+      data
+    end
+
+    # Retrieve packages count affected by zero day vulnerabilities
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :filter Filter packages using a query in Falcon Query Language (FQL). Supported filters: cid
+    # @return [Array<(CommonCountResponse, Integer, Hash)>] CommonCountResponse data, response status code and response headers
+    def read_packages_count_by_zero_day_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContainerPackagesApi.read_packages_count_by_zero_day ...'
+      end
+      # resource path
+      local_var_path = '/container-security/aggregates/packages/count-by-zero-day/v1'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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] || 'CommonCountResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['oauth2']
+
+      new_options = opts.merge(
+        :operation => :"ContainerPackagesApi.read_packages_count_by_zero_day",
+        :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: ContainerPackagesApi#read_packages_count_by_zero_day\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end