dependency-tracker-client 1.0.0

data/docs/MultiPart.md

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

data/docs/NotificationPublisher.md

@@ -0,0 +1,29 @@
+# DependencyTracker::NotificationPublisher
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**publisher_class** | **String** |  | 
+**template** | **String** |  | [optional] 
+**template_mime_type** | **String** |  | 
+**default_publisher** | **Boolean** |  | [optional] 
+**uuid** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::NotificationPublisher.new(name: null,
+                                 description: null,
+                                 publisher_class: null,
+                                 template: null,
+                                 template_mime_type: null,
+                                 default_publisher: null,
+                                 uuid: null)
+```
+
+

data/docs/NotificationRule.md

@@ -0,0 +1,35 @@
+# DependencyTracker::NotificationRule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**enabled** | **Boolean** |  | [optional] 
+**scope** | **String** |  | 
+**notification_level** | **String** |  | [optional] 
+**projects** | [**Array<Project>**](Project.md) |  | [optional] 
+**notify_on** | **Array<String>** |  | [optional] 
+**message** | **String** |  | [optional] 
+**publisher** | [**NotificationPublisher**](NotificationPublisher.md) |  | [optional] 
+**publisher_config** | **String** |  | [optional] 
+**uuid** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::NotificationRule.new(name: null,
+                                 enabled: null,
+                                 scope: null,
+                                 notification_level: null,
+                                 projects: null,
+                                 notify_on: null,
+                                 message: null,
+                                 publisher: null,
+                                 publisher_config: null,
+                                 uuid: null)
+```
+
+

data/docs/PackageURL.md

@@ -0,0 +1,29 @@
+# DependencyTracker::PackageURL
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**scheme** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**namespace** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**version** | **String** |  | [optional] 
+**qualifiers** | **Hash<String, String>** |  | [optional] 
+**subpath** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::PackageURL.new(scheme: null,
+                                 type: null,
+                                 namespace: null,
+                                 name: null,
+                                 version: null,
+                                 qualifiers: null,
+                                 subpath: null)
+```
+
+

data/docs/ParameterizedHeader.md

@@ -0,0 +1,19 @@
+# DependencyTracker::ParameterizedHeader
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | [optional] 
+**parameters** | **Hash<String, String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::ParameterizedHeader.new(value: null,
+                                 parameters: null)
+```
+
+

data/docs/Permission.md

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

data/docs/PermissionApi.md

@@ -0,0 +1,279 @@
+# DependencyTracker::PermissionApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_permission_to_team**](PermissionApi.md#add_permission_to_team) | **POST** /v1/permission/{permission}/team/{uuid} | Adds the permission to the specified username.
+[**add_permission_to_user**](PermissionApi.md#add_permission_to_user) | **POST** /v1/permission/{permission}/user/{username} | Adds the permission to the specified username.
+[**get_all_permissions**](PermissionApi.md#get_all_permissions) | **GET** /v1/permission | Returns a list of all permissions
+[**remove_permission_from_team**](PermissionApi.md#remove_permission_from_team) | **DELETE** /v1/permission/{permission}/team/{uuid} | Removes the permission from the team.
+[**remove_permission_from_user**](PermissionApi.md#remove_permission_from_user) | **DELETE** /v1/permission/{permission}/user/{username} | Removes the permission from the user.
+
+
+
+## add_permission_to_team
+
+> Team add_permission_to_team(uuid, permission)
+
+Adds the permission to the specified username.
+
+Requires 'manage users' 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::PermissionApi.new
+uuid = 'uuid_example' # String | A valid team uuid
+permission = 'permission_example' # String | A valid permission
+
+begin
+  #Adds the permission to the specified username.
+  result = api_instance.add_permission_to_team(uuid, permission)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling PermissionApi->add_permission_to_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| A valid team uuid | 
+ **permission** | **String**| A valid permission | 
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## add_permission_to_user
+
+> UserPrincipal add_permission_to_user(username, permission)
+
+Adds the permission to the specified username.
+
+### 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::PermissionApi.new
+username = 'username_example' # String | A valid username
+permission = 'permission_example' # String | A valid permission
+
+begin
+  #Adds the permission to the specified username.
+  result = api_instance.add_permission_to_user(username, permission)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling PermissionApi->add_permission_to_user: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **username** | **String**| A valid username | 
+ **permission** | **String**| A valid permission | 
+
+### Return type
+
+[**UserPrincipal**](UserPrincipal.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_all_permissions
+
+> Array<Permission> get_all_permissions
+
+Returns a list of all permissions
+
+### 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::PermissionApi.new
+
+begin
+  #Returns a list of all permissions
+  result = api_instance.get_all_permissions
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling PermissionApi->get_all_permissions: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Permission>**](Permission.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_permission_from_team
+
+> Team remove_permission_from_team(uuid, permission)
+
+Removes the permission from the 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::PermissionApi.new
+uuid = 'uuid_example' # String | A valid team uuid
+permission = 'permission_example' # String | A valid permission
+
+begin
+  #Removes the permission from the team.
+  result = api_instance.remove_permission_from_team(uuid, permission)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling PermissionApi->remove_permission_from_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| A valid team uuid | 
+ **permission** | **String**| A valid permission | 
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_permission_from_user
+
+> UserPrincipal remove_permission_from_user(username, permission)
+
+Removes the permission from the user.
+
+### 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::PermissionApi.new
+username = 'username_example' # String | A valid username
+permission = 'permission_example' # String | A valid permission
+
+begin
+  #Removes the permission from the user.
+  result = api_instance.remove_permission_from_user(username, permission)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling PermissionApi->remove_permission_from_user: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **username** | **String**| A valid username | 
+ **permission** | **String**| A valid permission | 
+
+### Return type
+
+[**UserPrincipal**](UserPrincipal.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PortfolioMetrics.md

@@ -0,0 +1,53 @@
+# DependencyTracker::PortfolioMetrics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**critical** | **Integer** |  | [optional] 
+**high** | **Integer** |  | [optional] 
+**medium** | **Integer** |  | [optional] 
+**low** | **Integer** |  | [optional] 
+**unassigned** | **Integer** |  | [optional] 
+**vulnerabilities** | **Integer** |  | [optional] 
+**projects** | **Integer** |  | [optional] 
+**vulnerable_projects** | **Integer** |  | [optional] 
+**components** | **Integer** |  | [optional] 
+**vulnerable_components** | **Integer** |  | [optional] 
+**dependencies** | **Integer** |  | [optional] 
+**vulnerable_dependencies** | **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::PortfolioMetrics.new(critical: null,
+                                 high: null,
+                                 medium: null,
+                                 low: null,
+                                 unassigned: null,
+                                 vulnerabilities: null,
+                                 projects: null,
+                                 vulnerable_projects: null,
+                                 components: null,
+                                 vulnerable_components: null,
+                                 dependencies: null,
+                                 vulnerable_dependencies: null,
+                                 suppressed: null,
+                                 findings_total: null,
+                                 findings_audited: null,
+                                 findings_unaudited: null,
+                                 inherited_risk_score: null,
+                                 first_occurrence: null,
+                                 last_occurrence: null)
+```
+
+

data/docs/Project.md

@@ -0,0 +1,43 @@
+# DependencyTracker::Project
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**version** | **String** |  | [optional] 
+**purl** | **String** |  | [optional] 
+**uuid** | **String** |  | 
+**parent** | [**Project**](Project.md) |  | [optional] 
+**children** | [**Array<Project>**](Project.md) |  | [optional] 
+**properties** | [**Array<ProjectProperty>**](ProjectProperty.md) |  | [optional] 
+**tags** | [**Array<Tag>**](Tag.md) |  | [optional] 
+**last_bom_import** | **Integer** |  | [optional] 
+**last_bom_import_format** | **String** |  | [optional] 
+**last_inherited_risk_score** | **Float** |  | [optional] 
+**active** | **Boolean** |  | [optional] 
+**metrics** | [**ProjectMetrics**](ProjectMetrics.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Project.new(name: null,
+                                 description: null,
+                                 version: null,
+                                 purl: null,
+                                 uuid: null,
+                                 parent: null,
+                                 children: null,
+                                 properties: null,
+                                 tags: null,
+                                 last_bom_import: null,
+                                 last_bom_import_format: null,
+                                 last_inherited_risk_score: null,
+                                 active: null,
+                                 metrics: null)
+```
+
+