dependency-tracker-client 1.0.0

data/docs/LicenseApi.md

@@ -0,0 +1,159 @@
+# DependencyTracker::LicenseApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_license**](LicenseApi.md#get_license) | **GET** /v1/license/{licenseId} | Returns a specific license
+[**get_license_listing**](LicenseApi.md#get_license_listing) | **GET** /v1/license/concise | Returns a concise listing of all licenses
+[**get_licenses**](LicenseApi.md#get_licenses) | **GET** /v1/license | Returns a list of all licenses with complete metadata for each license
+
+
+
+## get_license
+
+> License get_license(license_id)
+
+Returns a specific license
+
+### 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::LicenseApi.new
+license_id = 'license_id_example' # String | The SPDX License ID of the license to retrieve
+
+begin
+  #Returns a specific license
+  result = api_instance.get_license(license_id)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LicenseApi->get_license: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **license_id** | **String**| The SPDX License ID of the license to retrieve | 
+
+### Return type
+
+[**License**](License.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_license_listing
+
+> Array<License> get_license_listing
+
+Returns a concise listing of all licenses
+
+### 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::LicenseApi.new
+
+begin
+  #Returns a concise listing of all licenses
+  result = api_instance.get_license_listing
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LicenseApi->get_license_listing: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<License>**](License.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_licenses
+
+> Array<License> get_licenses
+
+Returns a list of all licenses with complete metadata for each license
+
+### 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::LicenseApi.new
+
+begin
+  #Returns a list of all licenses with complete metadata for each license
+  result = api_instance.get_licenses
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling LicenseApi->get_licenses: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<License>**](License.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ManagedUser.md

@@ -0,0 +1,37 @@
+# DependencyTracker::ManagedUser
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** |  | [optional] 
+**new_password** | **String** |  | [optional] 
+**confirm_password** | **String** |  | [optional] 
+**last_password_change** | **Integer** |  | 
+**fullname** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**suspended** | **Boolean** |  | [optional] 
+**force_password_change** | **Boolean** |  | [optional] 
+**non_expiry_password** | **Boolean** |  | [optional] 
+**teams** | [**Array<Team>**](Team.md) |  | [optional] 
+**permissions** | [**Array<Permission>**](Permission.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::ManagedUser.new(username: null,
+                                 new_password: null,
+                                 confirm_password: null,
+                                 last_password_change: null,
+                                 fullname: null,
+                                 email: null,
+                                 suspended: null,
+                                 force_password_change: null,
+                                 non_expiry_password: null,
+                                 teams: null,
+                                 permissions: null)
+```
+
+

data/docs/MappedLdapGroup.md

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

data/docs/MappedLdapGroupRequest.md

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

data/docs/MediaType.md

@@ -0,0 +1,25 @@
+# DependencyTracker::MediaType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**subtype** | **String** |  | [optional] 
+**parameters** | **Hash<String, String>** |  | [optional] 
+**wildcard_type** | **Boolean** |  | [optional] 
+**wildcard_subtype** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::MediaType.new(type: null,
+                                 subtype: null,
+                                 parameters: null,
+                                 wildcard_type: null,
+                                 wildcard_subtype: null)
+```
+
+