dependency-tracker-client 1.0.0

data/docs/SearchApi.md

@@ -0,0 +1,120 @@
+# DependencyTracker::SearchApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**search**](SearchApi.md#search) | **GET** /v1/search/{query} | Processes and returns search results
+[**search_via_query_string**](SearchApi.md#search_via_query_string) | **GET** /v1/search | Processes and returns search results
+
+
+
+## search
+
+> SearchResult search(query)
+
+Processes and returns search results
+
+Use of this endpoint may lead to URL encoding/decoding issues and is not recommended
+
+### 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::SearchApi.new
+query = 'query_example' # String | 
+
+begin
+  #Processes and returns search results
+  result = api_instance.search(query)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling SearchApi->search: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | 
+
+### Return type
+
+[**SearchResult**](SearchResult.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## search_via_query_string
+
+> SearchResult search_via_query_string(opts)
+
+Processes and returns search results
+
+Preferred search endpoint
+
+### 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::SearchApi.new
+opts = {
+  query: 'query_example' # String | 
+}
+
+begin
+  #Processes and returns search results
+  result = api_instance.search_via_query_string(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling SearchApi->search_via_query_string: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**|  | [optional] 
+
+### Return type
+
+[**SearchResult**](SearchResult.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SearchResult.md

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

data/docs/Tag.md

@@ -0,0 +1,19 @@
+# DependencyTracker::Tag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**projects** | [**Array<Project>**](Project.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Tag.new(name: null,
+                                 projects: null)
+```
+
+

data/docs/Team.md

@@ -0,0 +1,29 @@
+# DependencyTracker::Team
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **String** |  | 
+**name** | **String** |  | [optional] 
+**api_keys** | [**Array<ApiKey>**](ApiKey.md) |  | [optional] 
+**ldap_users** | [**Array<LdapUser>**](LdapUser.md) |  | [optional] 
+**managed_users** | [**Array<ManagedUser>**](ManagedUser.md) |  | [optional] 
+**mapped_ldap_groups** | [**Array<MappedLdapGroup>**](MappedLdapGroup.md) |  | [optional] 
+**permissions** | [**Array<Permission>**](Permission.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DependencyTracker'
+
+instance = DependencyTracker::Team.new(uuid: null,
+                                 name: null,
+                                 api_keys: null,
+                                 ldap_users: null,
+                                 managed_users: null,
+                                 mapped_ldap_groups: null,
+                                 permissions: null)
+```
+
+

data/docs/TeamApi.md

@@ -0,0 +1,432 @@
+# DependencyTracker::TeamApi
+
+All URIs are relative to *http://localhost/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_team**](TeamApi.md#create_team) | **PUT** /v1/team | Creates a new team along with an associated API key
+[**delete_api_key**](TeamApi.md#delete_api_key) | **DELETE** /v1/team/key/{apikey} | Deletes the specified API key
+[**delete_team**](TeamApi.md#delete_team) | **DELETE** /v1/team | Deletes a team
+[**generate_api_key**](TeamApi.md#generate_api_key) | **PUT** /v1/team/{uuid}/key | Generates an API key and returns its value
+[**get_team**](TeamApi.md#get_team) | **GET** /v1/team/{uuid} | Returns a specific team
+[**get_teams**](TeamApi.md#get_teams) | **GET** /v1/team | Returns a list of all teams
+[**regenerate_api_key**](TeamApi.md#regenerate_api_key) | **POST** /v1/team/key/{apikey} | Regenerates an API key by removing the specified key, generating a new one and returning its value
+[**update_team**](TeamApi.md#update_team) | **POST** /v1/team | Updates a team's fields including
+
+
+
+## create_team
+
+> Team create_team(opts)
+
+Creates a new team along with an associated API key
+
+### 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::TeamApi.new
+opts = {
+  body: DependencyTracker::Team.new # Team | 
+}
+
+begin
+  #Creates a new team along with an associated API key
+  result = api_instance.create_team(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->create_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Team**](Team.md)|  | [optional] 
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_api_key
+
+> delete_api_key(apikey)
+
+Deletes the specified API key
+
+### 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::TeamApi.new
+apikey = 'apikey_example' # String | The API key to delete
+
+begin
+  #Deletes the specified API key
+  api_instance.delete_api_key(apikey)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->delete_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **apikey** | **String**| The API key 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
+
+
+## delete_team
+
+> delete_team(opts)
+
+Deletes a 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::TeamApi.new
+opts = {
+  body: DependencyTracker::Team.new # Team | 
+}
+
+begin
+  #Deletes a team
+  api_instance.delete_team(opts)
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->delete_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Team**](Team.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
+
+
+## generate_api_key
+
+> ApiKey generate_api_key(uuid)
+
+Generates an API key and returns its value
+
+### 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::TeamApi.new
+uuid = 'uuid_example' # String | The UUID of the team to generate a key for
+
+begin
+  #Generates an API key and returns its value
+  result = api_instance.generate_api_key(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->generate_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the team to generate a key for | 
+
+### Return type
+
+[**ApiKey**](ApiKey.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_team
+
+> Team get_team(uuid)
+
+Returns a specific 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::TeamApi.new
+uuid = 'uuid_example' # String | The UUID of the team to retrieve
+
+begin
+  #Returns a specific team
+  result = api_instance.get_team(uuid)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->get_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **uuid** | **String**| The UUID of the team to retrieve | 
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_teams
+
+> Array<Team> get_teams
+
+Returns a list of all teams
+
+### 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::TeamApi.new
+
+begin
+  #Returns a list of all teams
+  result = api_instance.get_teams
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->get_teams: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<Team>**](Team.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## regenerate_api_key
+
+> ApiKey regenerate_api_key(apikey)
+
+Regenerates an API key by removing the specified key, generating a new one and returning its value
+
+### 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::TeamApi.new
+apikey = 'apikey_example' # String | The API key to regenerate
+
+begin
+  #Regenerates an API key by removing the specified key, generating a new one and returning its value
+  result = api_instance.regenerate_api_key(apikey)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->regenerate_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **apikey** | **String**| The API key to regenerate | 
+
+### Return type
+
+[**ApiKey**](ApiKey.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_team
+
+> Team update_team(opts)
+
+Updates a team's fields including
+
+### 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::TeamApi.new
+opts = {
+  body: DependencyTracker::Team.new # Team | 
+}
+
+begin
+  #Updates a team's fields including
+  result = api_instance.update_team(opts)
+  p result
+rescue DependencyTracker::ApiError => e
+  puts "Exception when calling TeamApi->update_team: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Team**](Team.md)|  | [optional] 
+
+### Return type
+
+[**Team**](Team.md)
+
+### Authorization
+
+[X-Api-Key](../README.md#X-Api-Key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+