dependency-tracker-client 1.0.0

data/docs/DependencyMetrics.md

@@ -0,0 +1,45 @@
+# DependencyTracker::DependencyMetrics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project** | [**Project**](Project.md) |  | 
+**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::DependencyMetrics.new(project: null,
+                                 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/DependencyRequest.md

@@ -0,0 +1,21 @@
+# DependencyTracker::DependencyRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**project_uuid** | **String** |  | [readonly] 
+**component_uuids** | **Array<String>** |  | [readonly] 
+**notes** | **String** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::DependencyRequest.new(project_uuid: null,
+                                 component_uuids: null,
+                                 notes: null)
+```
+
+

data/docs/Finding.md

@@ -0,0 +1,23 @@
+# DependencyTracker::Finding
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**component** | **Hash<String, Object>** |  | [optional] 
+**vulnerability** | **Hash<String, Object>** |  | [optional] 
+**analysis** | **Hash<String, Object>** |  | [optional] 
+**matrix** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Finding.new(component: null,
+                                 vulnerability: null,
+                                 analysis: null,
+                                 matrix: null)
+```
+
+

data/docs/FindingApi.md

@@ -0,0 +1,113 @@
+# DependencyTracker::FindingApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**export_findings_by_project**](FindingApi.md#export_findings_by_project) | **GET** /v1/finding/project/{uuid}/export | Returns a the findings for the specified project as FPF
+[**get_findings_by_project**](FindingApi.md#get_findings_by_project) | **GET** /v1/finding/project/{uuid} | Returns a list of all findings for a specific project
+
+
+
+## export_findings_by_project
+
+> export_findings_by_project(uuid)
+
+Returns a the findings for the specified project as FPF
+
+### 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::FindingApi.new
+uuid = 'uuid_example' # String | 
+
+begin
+  #Returns a the findings for the specified project as FPF
+  api_instance.export_findings_by_project(uuid)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling FindingApi->export_findings_by_project: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### 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_findings_by_project
+
+> Array<Finding> get_findings_by_project(uuid)
+
+Returns a list of all findings for a specific project
+
+### 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::FindingApi.new
+uuid = 'uuid_example' # String | 
+
+begin
+  #Returns a list of all findings for a specific project
+  result = api_instance.get_findings_by_project(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling FindingApi->get_findings_by_project: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**|  | 
+
+### Return type
+
+[**Array<Finding>**](Finding.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FormDataBodyPart.md

@@ -0,0 +1,39 @@
+# DependencyTracker::FormDataBodyPart
+
+## 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] 
+**form_data_content_disposition** | [**FormDataContentDisposition**](FormDataContentDisposition.md) |  | [optional] 
+**simple** | **Boolean** |  | [optional] 
+**name** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+**parameterized_headers** | **Hash<String, Array<ParameterizedHeader>>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::FormDataBodyPart.new(content_disposition: null,
+                                 entity: null,
+                                 headers: null,
+                                 media_type: null,
+                                 message_body_workers: null,
+                                 parent: null,
+                                 providers: null,
+                                 form_data_content_disposition: null,
+                                 simple: null,
+                                 name: null,
+                                 value: null,
+                                 parameterized_headers: null)
+```
+
+

data/docs/FormDataContentDisposition.md

@@ -0,0 +1,31 @@
+# DependencyTracker::FormDataContentDisposition
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**parameters** | **Hash<String, String>** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+**creation_date** | **Integer** |  | [optional] 
+**modification_date** | **Integer** |  | [optional] 
+**read_date** | **Integer** |  | [optional] 
+**size** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::FormDataContentDisposition.new(type: null,
+                                 parameters: null,
+                                 file_name: null,
+                                 creation_date: null,
+                                 modification_date: null,
+                                 read_date: null,
+                                 size: null,
+                                 name: null)
+```
+
+

data/docs/FormDataMultiPart.md

@@ -0,0 +1,35 @@
+# DependencyTracker::FormDataMultiPart
+
+## 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] 
+**body_parts** | [**Array<BodyPart>**](BodyPart.md) |  | [optional] 
+**fields** | **Hash<String, Array<FormDataBodyPart>>** |  | [optional] 
+**parameterized_headers** | **Hash<String, Array<ParameterizedHeader>>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::FormDataMultiPart.new(content_disposition: null,
+                                 entity: null,
+                                 headers: null,
+                                 media_type: null,
+                                 message_body_workers: null,
+                                 parent: null,
+                                 providers: null,
+                                 body_parts: null,
+                                 fields: null,
+                                 parameterized_headers: null)
+```
+
+

data/docs/Framework.md

@@ -0,0 +1,23 @@
+# DependencyTracker::Framework
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **String** |  | [optional] 
+**version** | **String** |  | [optional] 
+**uuid** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Framework.new(timestamp: null,
+                                 version: null,
+                                 uuid: null,
+                                 name: null)
+```
+
+

data/docs/IdentifiableObject.md

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

data/docs/LdapApi.md

@@ -0,0 +1,220 @@
+# DependencyTracker::LdapApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_mapping**](LdapApi.md#add_mapping) | **PUT** /v1/ldap/mapping | Adds a mapping
+[**delete_mapping**](LdapApi.md#delete_mapping) | **DELETE** /v1/ldap/mapping/{uuid} | Removes a mapping
+[**retrieve_ldap_groups**](LdapApi.md#retrieve_ldap_groups) | **GET** /v1/ldap/groups | Returns the DNs of all accessible groups within the directory
+[**retrieve_ldap_groups1**](LdapApi.md#retrieve_ldap_groups1) | **GET** /v1/ldap/team/{uuid} | Returns the DNs of all groups mapped to the specified team
+
+
+
+## add_mapping
+
+> MappedLdapGroup add_mapping(opts)
+
+Adds a mapping
+
+### 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::LdapApi.new
+opts = {
+  body: DependencyTracker::MappedLdapGroupRequest.new # MappedLdapGroupRequest | 
+}
+
+begin
+  #Adds a mapping
+  result = api_instance.add_mapping(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LdapApi->add_mapping: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MappedLdapGroupRequest**](MappedLdapGroupRequest.md)|  | [optional] 
+
+### Return type
+
+[**MappedLdapGroup**](MappedLdapGroup.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_mapping
+
+> MappedLdapGroup delete_mapping(uuid)
+
+Removes a mapping
+
+### 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::LdapApi.new
+uuid = 'uuid_example' # String | The UUID of the mapping to delete
+
+begin
+  #Removes a mapping
+  result = api_instance.delete_mapping(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LdapApi->delete_mapping: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the mapping to delete | 
+
+### Return type
+
+[**MappedLdapGroup**](MappedLdapGroup.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## retrieve_ldap_groups
+
+> Array<String> retrieve_ldap_groups
+
+Returns the DNs of all accessible groups within the directory
+
+This API performs a pass-thru query to the configured LDAP server. Search criteria results are cached using default Alpine CacheManager policy
+
+### 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::LdapApi.new
+
+begin
+  #Returns the DNs of all accessible groups within the directory
+  result = api_instance.retrieve_ldap_groups
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LdapApi->retrieve_ldap_groups: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## retrieve_ldap_groups1
+
+> Array<String> retrieve_ldap_groups1(uuid)
+
+Returns the DNs of all groups mapped to the specified team
+
+### 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::LdapApi.new
+uuid = 'uuid_example' # String | The UUID of the team to retrieve mappings for
+
+begin
+  #Returns the DNs of all groups mapped to the specified team
+  result = api_instance.retrieve_ldap_groups1(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LdapApi->retrieve_ldap_groups1: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the team to retrieve mappings for | 
+
+### Return type
+
+**Array<String>**
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/LdapUser.md

@@ -0,0 +1,25 @@
+# DependencyTracker::LdapUser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | [optional] 
+**dn** | **String** |  | [optional] 
+**teams** | [**Array<Team>**](Team.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+**permissions** | [**Array<Permission>**](Permission.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::LdapUser.new(username: null,
+                                 dn: null,
+                                 teams: null,
+                                 email: null,
+                                 permissions: null)
+```
+
+

data/docs/License.md

@@ -0,0 +1,37 @@
+# DependencyTracker::License
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | 
+**name** | **String** |  | [optional] 
+**license_text** | **String** |  | [optional] 
+**standard_license_template** | **String** |  | [optional] 
+**standard_license_header** | **String** |  | [optional] 
+**license_comments** | **String** |  | [optional] 
+**license_id** | **String** |  | [optional] 
+**is_osi_approved** | **Boolean** |  | [optional] 
+**is_fsf_libre** | **Boolean** |  | [optional] 
+**is_deprecated_license_id** | **Boolean** |  | [optional] 
+**see_also** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::License.new(uuid: null,
+                                 name: null,
+                                 license_text: null,
+                                 standard_license_template: null,
+                                 standard_license_header: null,
+                                 license_comments: null,
+                                 license_id: null,
+                                 is_osi_approved: null,
+                                 is_fsf_libre: null,
+                                 is_deprecated_license_id: null,
+                                 see_also: null)
+```
+
+