dependency-tracker-client 1.0.0

data/docs/BomSubmitRequest.md

@@ -0,0 +1,25 @@
+# DependencyTracker::BomSubmitRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project** | **String** |  | [readonly] 
+**project_name** | **String** |  | [optional] [readonly] 
+**project_version** | **String** |  | [optional] [readonly] 
+**auto_create** | **Boolean** |  | [optional] [readonly] 
+**bom** | **String** |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::BomSubmitRequest.new(project: null,
+                                 project_name: null,
+                                 project_version: null,
+                                 auto_create: null,
+                                 bom: null)
+```
+
+

data/docs/CalculatorApi.md

@@ -0,0 +1,61 @@
+# DependencyTracker::CalculatorApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_cvss_scores**](CalculatorApi.md#get_cvss_scores) | **GET** /v1/calculator/cvss | Returns the CVSS base score, impact sub-score and exploitability sub-score
+
+
+
+## get_cvss_scores
+
+> Score get_cvss_scores(vector)
+
+Returns the CVSS base score, impact sub-score and exploitability sub-score
+
+### 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::CalculatorApi.new
+vector = 'vector_example' # String | A valid CVSSv2 or CVSSv3 vector
+
+begin
+  #Returns the CVSS base score, impact sub-score and exploitability sub-score
+  result = api_instance.get_cvss_scores(vector)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling CalculatorApi->get_cvss_scores: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **vector** | **String**| A valid CVSSv2 or CVSSv3 vector | 
+
+### Return type
+
+[**Score**](Score.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CloneProjectRequest.md

@@ -0,0 +1,19 @@
+# DependencyTracker::CloneProjectRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project** | **String** |  | [readonly] 
+**version** | **String** |  | [readonly] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::CloneProjectRequest.new(project: null,
+                                 version: null)
+```
+
+

data/docs/Component.md

@@ -0,0 +1,69 @@
+# DependencyTracker::Component
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**version** | **String** |  | [optional] 
+**classifier** | **String** |  | [optional] 
+**filename** | **String** |  | [optional] 
+**extension** | **String** |  | [optional] 
+**md5** | **String** |  | [optional] 
+**sha1** | **String** |  | [optional] 
+**sha256** | **String** |  | [optional] 
+**sha512** | **String** |  | [optional] 
+**sha3_256** | **String** |  | [optional] 
+**sha3_512** | **String** |  | [optional] 
+**cpe** | **String** |  | [optional] 
+**purl** | [**PackageURL**](PackageURL.md) |  | [optional] 
+**description** | **String** |  | [optional] 
+**copyright** | **String** |  | [optional] 
+**license** | **String** |  | [optional] 
+**resolved_license** | [**License**](License.md) |  | [optional] 
+**parent** | [**Component**](Component.md) |  | [optional] 
+**children** | [**Array<Component>**](Component.md) |  | [optional] 
+**vulnerabilities** | [**Array<Vulnerability>**](Vulnerability.md) |  | [optional] 
+**last_inherited_risk_score** | **Float** |  | [optional] 
+**uuid** | **String** |  | 
+**metrics** | [**ComponentMetrics**](ComponentMetrics.md) |  | [optional] 
+**repository_meta** | [**RepositoryMetaComponent**](RepositoryMetaComponent.md) |  | [optional] 
+**used_by** | **Integer** |  | [optional] 
+**is_internal** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Component.new(group: null,
+                                 name: null,
+                                 version: null,
+                                 classifier: null,
+                                 filename: null,
+                                 extension: null,
+                                 md5: null,
+                                 sha1: null,
+                                 sha256: null,
+                                 sha512: null,
+                                 sha3_256: null,
+                                 sha3_512: null,
+                                 cpe: null,
+                                 purl: null,
+                                 description: null,
+                                 copyright: null,
+                                 license: null,
+                                 resolved_license: null,
+                                 parent: null,
+                                 children: null,
+                                 vulnerabilities: null,
+                                 last_inherited_risk_score: null,
+                                 uuid: null,
+                                 metrics: null,
+                                 repository_meta: null,
+                                 used_by: null,
+                                 is_internal: null)
+```
+
+

data/docs/ComponentApi.md

@@ -0,0 +1,373 @@
+# DependencyTracker::ComponentApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_component**](ComponentApi.md#create_component) | **PUT** /v1/component | Creates a new component
+[**delete_component**](ComponentApi.md#delete_component) | **DELETE** /v1/component/{uuid} | Deletes a component
+[**get_all_components**](ComponentApi.md#get_all_components) | **GET** /v1/component | Returns a list of all components
+[**get_component_by_hash**](ComponentApi.md#get_component_by_hash) | **GET** /v1/component/hash/{hash} | Returns a specific component
+[**get_component_by_uuid**](ComponentApi.md#get_component_by_uuid) | **GET** /v1/component/{uuid} | Returns a specific component
+[**identify_internal_components**](ComponentApi.md#identify_internal_components) | **GET** /v1/component/internal/identify | Requests the identification of internal components in the portfolio
+[**update_component**](ComponentApi.md#update_component) | **POST** /v1/component | Updates a component
+
+
+
+## create_component
+
+> Component create_component(opts)
+
+Creates a new component
+
+### 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::ComponentApi.new
+opts = {
+  body: DependencyTracker::Component.new # Component | 
+}
+
+begin
+  #Creates a new component
+  result = api_instance.create_component(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->create_component: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Component**](Component.md)|  | [optional] 
+
+### Return type
+
+[**Component**](Component.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_component
+
+> delete_component(uuid)
+
+Deletes a component
+
+### 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::ComponentApi.new
+uuid = 'uuid_example' # String | The UUID of the component to delete
+
+begin
+  #Deletes a component
+  api_instance.delete_component(uuid)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->delete_component: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the component to delete | 
+
+### 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
+
+
+## get_all_components
+
+> Array<Component> get_all_components
+
+Returns a list of all components
+
+### 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::ComponentApi.new
+
+begin
+  #Returns a list of all components
+  result = api_instance.get_all_components
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->get_all_components: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Component>**](Component.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_component_by_hash
+
+> Component get_component_by_hash(hash)
+
+Returns a specific component
+
+### 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::ComponentApi.new
+hash = 'hash_example' # String | The MD5, SHA-1, SHA-256, SHA-512, SHA3-256, or SHA3-512 hash of the component to retrieve
+
+begin
+  #Returns a specific component
+  result = api_instance.get_component_by_hash(hash)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->get_component_by_hash: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **hash** | **String**| The MD5, SHA-1, SHA-256, SHA-512, SHA3-256, or SHA3-512 hash of the component to retrieve | 
+
+### Return type
+
+[**Component**](Component.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_component_by_uuid
+
+> Component get_component_by_uuid(uuid)
+
+Returns a specific component
+
+### 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::ComponentApi.new
+uuid = 'uuid_example' # String | The UUID of the component to retrieve
+
+begin
+  #Returns a specific component
+  result = api_instance.get_component_by_uuid(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->get_component_by_uuid: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the component to retrieve | 
+
+### Return type
+
+[**Component**](Component.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## identify_internal_components
+
+> identify_internal_components
+
+Requests the identification of internal components in the portfolio
+
+### 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::ComponentApi.new
+
+begin
+  #Requests the identification of internal components in the portfolio
+  api_instance.identify_internal_components
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->identify_internal_components: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### 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
+
+
+## update_component
+
+> Component update_component(opts)
+
+Updates a component
+
+### 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::ComponentApi.new
+opts = {
+  body: DependencyTracker::Component.new # Component | 
+}
+
+begin
+  #Updates a component
+  result = api_instance.update_component(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling ComponentApi->update_component: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Component**](Component.md)|  | [optional] 
+
+### Return type
+
+[**Component**](Component.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ComponentMetrics.md

@@ -0,0 +1,43 @@
+# DependencyTracker::ComponentMetrics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**component** | [**Component**](Component.md) |  | 
+**critical** | **Integer** |  | [optional] 
+**high** | **Integer** |  | [optional] 
+**medium** | **Integer** |  | [optional] 
+**low** | **Integer** |  | [optional] 
+**unassigned** | **Integer** |  | [optional] 
+**vulnerabilities** | **Integer** |  | [optional] 
+**suppressed** | **Integer** |  | [optional] 
+**findings_total** | **Integer** |  | [optional] 
+**findings_audited** | **Integer** |  | [optional] 
+**findings_unaudited** | **Integer** |  | [optional] 
+**inherited_risk_score** | **Float** |  | [optional] 
+**first_occurrence** | **Integer** |  | 
+**last_occurrence** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::ComponentMetrics.new(component: null,
+                                 critical: null,
+                                 high: null,
+                                 medium: null,
+                                 low: null,
+                                 unassigned: null,
+                                 vulnerabilities: null,
+                                 suppressed: null,
+                                 findings_total: null,
+                                 findings_audited: null,
+                                 findings_unaudited: null,
+                                 inherited_risk_score: null,
+                                 first_occurrence: null,
+                                 last_occurrence: null)
+```
+
+

data/docs/ConfigProperty.md

@@ -0,0 +1,25 @@
+# DependencyTracker::ConfigProperty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**group_name** | **String** |  | [optional] 
+**property_name** | **String** |  | [optional] 
+**property_value** | **String** |  | [optional] 
+**property_type** | **String** |  | 
+**description** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::ConfigProperty.new(group_name: null,
+                                 property_name: null,
+                                 property_value: null,
+                                 property_type: null,
+                                 description: null)
+```
+
+