nodeum_sdk 1.85.1

data/docs/TooLong.md

@@ -0,0 +1,17 @@
+# Nodeum::TooLong
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Expected maximum length | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TooLong.new(count: null)
+```
+
+

data/docs/TooLongAllOf.md

@@ -0,0 +1,17 @@
+# Nodeum::TooLongAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Expected maximum length | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TooLongAllOf.new(count: null)
+```
+
+

data/docs/TooShort.md

@@ -0,0 +1,17 @@
+# Nodeum::TooShort
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Expected minimum length | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TooShort.new(count: null)
+```
+
+

data/docs/TooShortAllOf.md

@@ -0,0 +1,17 @@
+# Nodeum::TooShortAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Expected minimum length | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TooShortAllOf.new(count: null)
+```
+
+

data/docs/TypeToSecondaryFacets.md

@@ -0,0 +1,25 @@
+# Nodeum::TypeToSecondaryFacets
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**on_secondary_nas** | [**BySecondaryTypeFacet**](BySecondaryTypeFacet.md) |  | [optional] 
+**on_secondary_public_cloud** | [**BySecondaryTypeFacet**](BySecondaryTypeFacet.md) |  | [optional] 
+**on_secondary_object_cloud** | [**BySecondaryTypeFacet**](BySecondaryTypeFacet.md) |  | [optional] 
+**on_secondary_tape** | [**BySecondaryTypeFacet**](BySecondaryTypeFacet.md) |  | [optional] 
+**on_no_secondary** | [**BySecondaryTypeFacet**](BySecondaryTypeFacet.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TypeToSecondaryFacets.new(on_secondary_nas: null,
+                                 on_secondary_public_cloud: null,
+                                 on_secondary_object_cloud: null,
+                                 on_secondary_tape: null,
+                                 on_no_secondary: null)
+```
+
+

data/docs/UsersApi.md

@@ -0,0 +1,418 @@
+# Nodeum::UsersApi
+
+All URIs are relative to *http://localhost/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_api_key**](UsersApi.md#create_api_key) | **POST** /users/me/api_keys | Creates a new API Key for current user.
+[**destroy_api_key**](UsersApi.md#destroy_api_key) | **DELETE** /users/me/api_keys/{api_key_id} | Destroys a specific API Key.
+[**index_api_keys**](UsersApi.md#index_api_keys) | **GET** /users/me/api_keys | Lists all API keys of current user.
+[**index_system_groups**](UsersApi.md#index_system_groups) | **GET** /groups/-/systems | List all system groups.
+[**index_system_users**](UsersApi.md#index_system_users) | **GET** /users/-/systems | List all system users.
+[**show_api_key**](UsersApi.md#show_api_key) | **GET** /users/me/api_keys/{api_key_id} | Displays a specific API Key with its scopes.
+[**update_api_key**](UsersApi.md#update_api_key) | **PUT** /users/me/api_keys/{api_key_id} | Updates a specific API Key.
+
+
+
+## create_api_key
+
+> ApiKeyFull create_api_key(api_key_body)
+
+Creates a new API Key for current user.
+
+**API Key Scope**: api_keys / create
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+api_key_body = Nodeum::ApiKeyFull.new # ApiKeyFull | 
+
+begin
+  #Creates a new API Key for current user.
+  result = api_instance.create_api_key(api_key_body)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->create_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key_body** | [**ApiKeyFull**](ApiKeyFull.md)|  | 
+
+### Return type
+
+[**ApiKeyFull**](ApiKeyFull.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## destroy_api_key
+
+> destroy_api_key(api_key_id)
+
+Destroys a specific API Key.
+
+**API Key Scope**: api_keys / destroy
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+api_key_id = 56 # Integer | Numeric ID of API Key.
+
+begin
+  #Destroys a specific API Key.
+  api_instance.destroy_api_key(api_key_id)
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->destroy_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key_id** | **Integer**| Numeric ID of API Key. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## index_api_keys
+
+> ApiKeyCollection index_api_keys(opts)
+
+Lists all API keys of current user.
+
+**API Key Scope**: api_keys / index
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+opts = {
+  limit: 56, # Integer | The number of items to display for pagination.
+  offset: 56 # Integer | The number of items to skip for pagination.
+}
+
+begin
+  #Lists all API keys of current user.
+  result = api_instance.index_api_keys(opts)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->index_api_keys: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of items to display for pagination. | [optional] 
+ **offset** | **Integer**| The number of items to skip for pagination. | [optional] 
+
+### Return type
+
+[**ApiKeyCollection**](ApiKeyCollection.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## index_system_groups
+
+> SystemGroupCollection index_system_groups
+
+List all system groups.
+
+**API Key Scope**: groups / systems
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+
+begin
+  #List all system groups.
+  result = api_instance.index_system_groups
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->index_system_groups: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SystemGroupCollection**](SystemGroupCollection.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## index_system_users
+
+> SystemUserCollection index_system_users
+
+List all system users.
+
+**API Key Scope**: users / systems
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+
+begin
+  #List all system users.
+  result = api_instance.index_system_users
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->index_system_users: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SystemUserCollection**](SystemUserCollection.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## show_api_key
+
+> ApiKeyFull show_api_key(api_key_id)
+
+Displays a specific API Key with its scopes.
+
+**API Key Scope**: api_keys / show
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+api_key_id = 56 # Integer | Numeric ID of API Key.
+
+begin
+  #Displays a specific API Key with its scopes.
+  result = api_instance.show_api_key(api_key_id)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->show_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key_id** | **Integer**| Numeric ID of API Key. | 
+
+### Return type
+
+[**ApiKeyFull**](ApiKeyFull.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_api_key
+
+> ApiKeyFull update_api_key(api_key_id, api_key_body)
+
+Updates a specific API Key.
+
+**API Key Scope**: api_keys / update
+
+### Example
+
+```ruby
+# load the gem
+require 'nodeum_sdk'
+# setup authorization
+Nodeum.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: BearerAuth
+  config.api_key['Authorization'] = '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['Authorization'] = 'Bearer'
+end
+
+api_instance = Nodeum::UsersApi.new
+api_key_id = 56 # Integer | Numeric ID of API Key.
+api_key_body = Nodeum::ApiKeyFull.new # ApiKeyFull | 
+
+begin
+  #Updates a specific API Key.
+  result = api_instance.update_api_key(api_key_id, api_key_body)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling UsersApi->update_api_key: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **api_key_id** | **Integer**| Numeric ID of API Key. | 
+ **api_key_body** | [**ApiKeyFull**](ApiKeyFull.md)|  | 
+
+### Return type
+
+[**ApiKeyFull**](ApiKeyFull.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+