dependency-tracker-client 1.0.0

data/docs/VulnerableSoftware.md

@@ -0,0 +1,69 @@
+# DependencyTracker::VulnerableSoftware
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purl** | **String** |  | [optional] 
+**purl_type** | **String** |  | [optional] 
+**purl_namespace** | **String** |  | [optional] 
+**purl_name** | **String** |  | [optional] 
+**purl_version** | **String** |  | [optional] 
+**purl_qualifiers** | **String** |  | [optional] 
+**purl_subpath** | **String** |  | [optional] 
+**cpe22** | **String** |  | [optional] 
+**cpe23** | **String** |  | [optional] 
+**part** | **String** |  | [optional] 
+**vendor** | **String** |  | [optional] 
+**product** | **String** |  | [optional] 
+**version** | **String** |  | [optional] 
+**update** | **String** |  | [optional] 
+**edition** | **String** |  | [optional] 
+**language** | **String** |  | [optional] 
+**sw_edition** | **String** |  | [optional] 
+**target_sw** | **String** |  | [optional] 
+**target_hw** | **String** |  | [optional] 
+**other** | **String** |  | [optional] 
+**version_end_excluding** | **String** |  | [optional] 
+**version_end_including** | **String** |  | [optional] 
+**version_start_excluding** | **String** |  | [optional] 
+**version_start_including** | **String** |  | [optional] 
+**vulnerabilities** | [**Array<Vulnerability>**](Vulnerability.md) |  | [optional] 
+**uuid** | **String** |  | [optional] 
+**is_vulnerable** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::VulnerableSoftware.new(purl: null,
+                                 purl_type: null,
+                                 purl_namespace: null,
+                                 purl_name: null,
+                                 purl_version: null,
+                                 purl_qualifiers: null,
+                                 purl_subpath: null,
+                                 cpe22: null,
+                                 cpe23: null,
+                                 part: null,
+                                 vendor: null,
+                                 product: null,
+                                 version: null,
+                                 update: null,
+                                 edition: null,
+                                 language: null,
+                                 sw_edition: null,
+                                 target_sw: null,
+                                 target_hw: null,
+                                 other: null,
+                                 version_end_excluding: null,
+                                 version_end_including: null,
+                                 version_start_excluding: null,
+                                 version_start_including: null,
+                                 vulnerabilities: null,
+                                 uuid: null,
+                                 is_vulnerable: null)
+```
+
+

data/lib/dependency-tracker-client/api/analysis_api.rb

@@ -0,0 +1,209 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module DependencyTracker
+  class AnalysisApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieves an analysis trail
+    # @param component [String] The UUID of the component
+    # @param vulnerability [String] The UUID of the vulnerability
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :project The UUID of the project
+    # @return [Analysis]
+    def retrieve_analysis(component, vulnerability, opts = {})
+      data, _status_code, _headers = retrieve_analysis_with_http_info(component, vulnerability, opts)
+      data
+    end
+
+    # Retrieves an analysis trail
+    # @param component [String] The UUID of the component
+    # @param vulnerability [String] The UUID of the vulnerability
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :project The UUID of the project
+    # @return [Array<(Analysis, Integer, Hash)>] Analysis data, response status code and response headers
+    def retrieve_analysis_with_http_info(component, vulnerability, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalysisApi.retrieve_analysis ...'
+      end
+      # verify the required parameter 'component' is set
+      if @api_client.config.client_side_validation && component.nil?
+        fail ArgumentError, "Missing the required parameter 'component' when calling AnalysisApi.retrieve_analysis"
+      end
+      # verify the required parameter 'vulnerability' is set
+      if @api_client.config.client_side_validation && vulnerability.nil?
+        fail ArgumentError, "Missing the required parameter 'vulnerability' when calling AnalysisApi.retrieve_analysis"
+      end
+      # resource path
+      local_var_path = '/v1/analysis'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'component'] = component
+      query_params[:'vulnerability'] = vulnerability
+      query_params[:'project'] = opts[:'project'] if !opts[:'project'].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[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Analysis' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: AnalysisApi#retrieve_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Records an analysis decision
+    # @param [Hash] opts the optional parameters
+    # @option opts [AnalysisRequest] :body 
+    # @return [Analysis]
+    def update_analysis(opts = {})
+      data, _status_code, _headers = update_analysis_with_http_info(opts)
+      data
+    end
+
+    # Records an analysis decision
+    # @param [Hash] opts the optional parameters
+    # @option opts [AnalysisRequest] :body 
+    # @return [Array<(Analysis, Integer, Hash)>] Analysis data, response status code and response headers
+    def update_analysis_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalysisApi.update_analysis ...'
+      end
+      # resource path
+      local_var_path = '/v1/analysis'
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Analysis' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalysisApi#update_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Records an analysis decision
+    # @param [Hash] opts the optional parameters
+    # @option opts [AnalysisRequest] :body 
+    # @return [Analysis]
+    def update_global_analysis(opts = {})
+      data, _status_code, _headers = update_global_analysis_with_http_info(opts)
+      data
+    end
+
+    # Records an analysis decision
+    # @param [Hash] opts the optional parameters
+    # @option opts [AnalysisRequest] :body 
+    # @return [Array<(Analysis, Integer, Hash)>] Analysis data, response status code and response headers
+    def update_global_analysis_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalysisApi.update_global_analysis ...'
+      end
+      # resource path
+      local_var_path = '/v1/analysis/global'
+
+      # 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'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Analysis' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnalysisApi#update_global_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/dependency-tracker-client/api/badge_api.rb

@@ -0,0 +1,148 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module DependencyTracker
+  class BadgeApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns current metrics for a specific project
+    # @param name [String] The name of the project to query on
+    # @param version [String] The version of the project to query on
+    # @param [Hash] opts the optional parameters
+    # @return [ProjectMetrics]
+    def get_project_vulnerabilities_badge(name, version, opts = {})
+      data, _status_code, _headers = get_project_vulnerabilities_badge_with_http_info(name, version, opts)
+      data
+    end
+
+    # Returns current metrics for a specific project
+    # @param name [String] The name of the project to query on
+    # @param version [String] The version of the project to query on
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProjectMetrics, Integer, Hash)>] ProjectMetrics data, response status code and response headers
+    def get_project_vulnerabilities_badge_with_http_info(name, version, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BadgeApi.get_project_vulnerabilities_badge ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling BadgeApi.get_project_vulnerabilities_badge"
+      end
+      # verify the required parameter 'version' is set
+      if @api_client.config.client_side_validation && version.nil?
+        fail ArgumentError, "Missing the required parameter 'version' when calling BadgeApi.get_project_vulnerabilities_badge"
+      end
+      # resource path
+      local_var_path = '/v1/badge/vulns/project/{name}/{version}'.sub('{' + 'name' + '}', CGI.escape(name.to_s)).sub('{' + 'version' + '}', CGI.escape(version.to_s))
+
+      # 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(['image/svg+xml'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ProjectMetrics' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :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: BadgeApi#get_project_vulnerabilities_badge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns current metrics for a specific project
+    # @param uuid [String] The UUID of the project to retrieve metrics for
+    # @param [Hash] opts the optional parameters
+    # @return [ProjectMetrics]
+    def get_project_vulnerabilities_badge1(uuid, opts = {})
+      data, _status_code, _headers = get_project_vulnerabilities_badge1_with_http_info(uuid, opts)
+      data
+    end
+
+    # Returns current metrics for a specific project
+    # @param uuid [String] The UUID of the project to retrieve metrics for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ProjectMetrics, Integer, Hash)>] ProjectMetrics data, response status code and response headers
+    def get_project_vulnerabilities_badge1_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BadgeApi.get_project_vulnerabilities_badge1 ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling BadgeApi.get_project_vulnerabilities_badge1"
+      end
+      # resource path
+      local_var_path = '/v1/badge/vulns/project/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))
+
+      # 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(['image/svg+xml'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'ProjectMetrics' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :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: BadgeApi#get_project_vulnerabilities_badge1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end