dependency-tracker-client 1.0.0

data/docs/AnalysisApi.md

@@ -0,0 +1,177 @@
+# DependencyTracker::AnalysisApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**retrieve_analysis**](AnalysisApi.md#retrieve_analysis) | **GET** /v1/analysis | Retrieves an analysis trail
+[**update_analysis**](AnalysisApi.md#update_analysis) | **PUT** /v1/analysis | Records an analysis decision
+[**update_global_analysis**](AnalysisApi.md#update_global_analysis) | **PUT** /v1/analysis/global | Records an analysis decision
+
+
+
+## retrieve_analysis
+
+> Analysis retrieve_analysis(component, vulnerability, opts)
+
+Retrieves an analysis trail
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::AnalysisApi.new
+component = 'component_example' # String | The UUID of the component
+vulnerability = 'vulnerability_example' # String | The UUID of the vulnerability
+opts = {
+  project: 'project_example' # String | The UUID of the project
+}
+
+begin
+  #Retrieves an analysis trail
+  result = api_instance.retrieve_analysis(component, vulnerability, opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling AnalysisApi->retrieve_analysis: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **component** | **String**| The UUID of the component | 
+ **vulnerability** | **String**| The UUID of the vulnerability | 
+ **project** | **String**| The UUID of the project | [optional] 
+
+### Return type
+
+[**Analysis**](Analysis.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_analysis
+
+> Analysis update_analysis(opts)
+
+Records an analysis decision
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::AnalysisApi.new
+opts = {
+  body: DependencyTracker::AnalysisRequest.new # AnalysisRequest | 
+}
+
+begin
+  #Records an analysis decision
+  result = api_instance.update_analysis(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling AnalysisApi->update_analysis: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AnalysisRequest**](AnalysisRequest.md)|  | [optional] 
+
+### Return type
+
+[**Analysis**](Analysis.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_global_analysis
+
+> Analysis update_global_analysis(opts)
+
+Records an analysis decision
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::AnalysisApi.new
+opts = {
+  body: DependencyTracker::AnalysisRequest.new # AnalysisRequest | 
+}
+
+begin
+  #Records an analysis decision
+  result = api_instance.update_global_analysis(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling AnalysisApi->update_global_analysis: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AnalysisRequest**](AnalysisRequest.md)|  | [optional] 
+
+### Return type
+
+[**Analysis**](Analysis.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AnalysisComment.md

@@ -0,0 +1,21 @@
+# DependencyTracker::AnalysisComment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **Integer** |  | 
+**comment** | **String** |  | 
+**commenter** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::AnalysisComment.new(timestamp: null,
+                                 comment: null,
+                                 commenter: null)
+```
+
+

data/docs/AnalysisRequest.md

@@ -0,0 +1,27 @@
+# DependencyTracker::AnalysisRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project** | **String** |  | [optional] [readonly] 
+**component** | **String** |  | [readonly] 
+**vulnerability** | **String** |  | [readonly] 
+**analysis_state** | **String** |  | [optional] [readonly] 
+**comment** | **String** |  | [optional] [readonly] 
+**suppressed** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::AnalysisRequest.new(project: null,
+                                 component: null,
+                                 vulnerability: null,
+                                 analysis_state: null,
+                                 comment: null,
+                                 suppressed: null)
+```
+
+

data/docs/ApiKey.md

@@ -0,0 +1,17 @@
+# DependencyTracker::ApiKey
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::ApiKey.new(key: null)
+```
+
+

data/docs/BadgeApi.md

@@ -0,0 +1,102 @@
+# DependencyTracker::BadgeApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_project_vulnerabilities_badge**](BadgeApi.md#get_project_vulnerabilities_badge) | **GET** /v1/badge/vulns/project/{name}/{version} | Returns current metrics for a specific project
+[**get_project_vulnerabilities_badge1**](BadgeApi.md#get_project_vulnerabilities_badge1) | **GET** /v1/badge/vulns/project/{uuid} | Returns current metrics for a specific project
+
+
+
+## get_project_vulnerabilities_badge
+
+> ProjectMetrics get_project_vulnerabilities_badge(name, version)
+
+Returns current metrics for a specific project
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+
+api_instance = DependencyTracker::BadgeApi.new
+name = 'name_example' # String | The name of the project to query on
+version = 'version_example' # String | The version of the project to query on
+
+begin
+  #Returns current metrics for a specific project
+  result = api_instance.get_project_vulnerabilities_badge(name, version)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BadgeApi->get_project_vulnerabilities_badge: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **name** | **String**| The name of the project to query on | 
+ **version** | **String**| The version of the project to query on | 
+
+### Return type
+
+[**ProjectMetrics**](ProjectMetrics.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/svg+xml
+
+
+## get_project_vulnerabilities_badge1
+
+> ProjectMetrics get_project_vulnerabilities_badge1(uuid)
+
+Returns current metrics for a specific project
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+
+api_instance = DependencyTracker::BadgeApi.new
+uuid = 'uuid_example' # String | The UUID of the project to retrieve metrics for
+
+begin
+  #Returns current metrics for a specific project
+  result = api_instance.get_project_vulnerabilities_badge1(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BadgeApi->get_project_vulnerabilities_badge1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the project to retrieve metrics for | 
+
+### Return type
+
+[**ProjectMetrics**](ProjectMetrics.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: image/svg+xml
+

data/docs/BodyPart.md

@@ -0,0 +1,31 @@
+# DependencyTracker::BodyPart
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content_disposition** | [**ContentDisposition**](ContentDisposition.md) |  | [optional] 
+**entity** | [**Object**](.md) |  | [optional] 
+**headers** | **Hash<String, Array<String>>** |  | [optional] 
+**media_type** | [**MediaType**](MediaType.md) |  | [optional] 
+**message_body_workers** | [**Object**](.md) |  | [optional] 
+**parent** | [**MultiPart**](MultiPart.md) |  | [optional] 
+**providers** | [**Object**](.md) |  | [optional] 
+**parameterized_headers** | **Hash<String, Array<ParameterizedHeader>>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::BodyPart.new(content_disposition: null,
+                                 entity: null,
+                                 headers: null,
+                                 media_type: null,
+                                 message_body_workers: null,
+                                 parent: null,
+                                 providers: null,
+                                 parameterized_headers: null)
+```
+
+

data/docs/BomApi.md

@@ -0,0 +1,335 @@
+# DependencyTracker::BomApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**export_component_as_cyclone_dx**](BomApi.md#export_component_as_cyclone_dx) | **GET** /v1/bom/cyclonedx/component/{uuid} | Returns dependency metadata for a specific component in CycloneDX format
+[**export_components_as_cyclone_dx**](BomApi.md#export_components_as_cyclone_dx) | **GET** /v1/bom/cyclonedx/components | Returns dependency metadata for all components in CycloneDX format
+[**export_project_as_cyclone_dx**](BomApi.md#export_project_as_cyclone_dx) | **GET** /v1/bom/cyclonedx/project/{uuid} | Returns dependency metadata for a project in CycloneDX format
+[**is_token_being_processed**](BomApi.md#is_token_being_processed) | **GET** /v1/bom/token/{uuid} | Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
+[**upload_bom**](BomApi.md#upload_bom) | **POST** /v1/bom | Upload a supported bill of material format document
+[**upload_bom1**](BomApi.md#upload_bom1) | **PUT** /v1/bom | Upload a supported bill of material format document
+
+
+
+## export_component_as_cyclone_dx
+
+> String export_component_as_cyclone_dx(uuid)
+
+Returns dependency metadata for a specific component in CycloneDX format
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::BomApi.new
+uuid = 'uuid_example' # String | The UUID of the project to export
+
+begin
+  #Returns dependency metadata for a specific component in CycloneDX format
+  result = api_instance.export_component_as_cyclone_dx(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BomApi->export_component_as_cyclone_dx: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the project to export | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/xml
+
+
+## export_components_as_cyclone_dx
+
+> String export_components_as_cyclone_dx
+
+Returns dependency metadata for all components in CycloneDX format
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::BomApi.new
+
+begin
+  #Returns dependency metadata for all components in CycloneDX format
+  result = api_instance.export_components_as_cyclone_dx
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BomApi->export_components_as_cyclone_dx: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/xml
+
+
+## export_project_as_cyclone_dx
+
+> String export_project_as_cyclone_dx(uuid)
+
+Returns dependency metadata for a project in CycloneDX format
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::BomApi.new
+uuid = 'uuid_example' # String | The UUID of the project to export
+
+begin
+  #Returns dependency metadata for a project in CycloneDX format
+  result = api_instance.export_project_as_cyclone_dx(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BomApi->export_project_as_cyclone_dx: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the project to export | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/xml
+
+
+## is_token_being_processed
+
+> is_token_being_processed(uuid)
+
+Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
+
+This endpoint is intended to be used in conjunction with uploading a supported BOM document. Upon upload, a token will be returned. The token can then be queried using this endpoint to determine if any tasks (such as vulnerability analysis) is being performed on the BOM. A value of true indicates processing is occurring. A value of false indicates that no processing is occurring for the specified token. However, a value of false also does not confirm the token is valid, only that no processing is associated with the specified token.
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::BomApi.new
+uuid = 'uuid_example' # String | The UUID of the token to query
+
+begin
+  #Determines if there are any tasks associated with the token that are being processed, or in the queue to be processed.
+  api_instance.is_token_being_processed(uuid)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BomApi->is_token_being_processed: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the token to query | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## upload_bom
+
+> upload_bom(opts)
+
+Upload a supported bill of material format document
+
+Expects CycloneDX or SPDX (text or RDF) along and a valid project UUID. If a UUID is not specified, than the projectName and projectVersion must be specified. Optionally, if autoCreate is specified and 'true' and the project does not exist, the project will be created. In this scenario, the principal making the request will additionally need the PORTFOLIO_MANAGEMENT or PROJECT_CREATION_UPLOAD permission.
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::BomApi.new
+opts = {
+  project: 'project_example', # String | 
+  auto_create: false, # Boolean | 
+  project_name: 'project_name_example', # String | 
+  project_version: 'project_version_example' # String | 
+}
+
+begin
+  #Upload a supported bill of material format document
+  api_instance.upload_bom(opts)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BomApi->upload_bom: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **project** | **String**|  | [optional] 
+ **auto_create** | **Boolean**|  | [optional] [default to false]
+ **project_name** | **String**|  | [optional] 
+ **project_version** | **String**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: Not defined
+
+
+## upload_bom1
+
+> upload_bom1(opts)
+
+Upload a supported bill of material format document
+
+Expects CycloneDX or SPDX (text or RDF) along and a valid project UUID. If a UUID is not specified, than the projectName and projectVersion must be specified. Optionally, if autoCreate is specified and 'true' and the project does not exist, the project will be created. In this scenario, the principal making the request will additionally need the PORTFOLIO_MANAGEMENT or PROJECT_CREATION_UPLOAD permission.
+
+### Example
+
+```ruby
+# load the gem
+require 'dependency-tracker-client'
+# setup authorization
+DependencyTracker.configure do |config|
+  # Configure API key authorization: X-Api-Key
+  config.api_key['X-Api-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['X-Api-Key'] = 'Bearer'
+end
+
+api_instance = DependencyTracker::BomApi.new
+opts = {
+  body: DependencyTracker::BomSubmitRequest.new # BomSubmitRequest | 
+}
+
+begin
+  #Upload a supported bill of material format document
+  api_instance.upload_bom1(opts)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling BomApi->upload_bom1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**BomSubmitRequest**](BomSubmitRequest.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+