nodeum_sdk 1.85.1

data/docs/Task.md

@@ -0,0 +1,55 @@
+# Nodeum::Task
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] [readonly] 
+**name** | **String** |  | [optional] 
+**comment** | **String** |  | [optional] 
+**workflow_type** | **String** |  | [optional] 
+**workflow_action** | **String** |  | [optional] 
+**source_type** | **String** |  | [optional] 
+**destination_type** | **String** |  | [optional] 
+**priority** | **Integer** |  | [optional] 
+**conflict_resolution** | **String** |  | [optional] 
+**action** | **String** |  | [optional] [readonly] 
+**activate** | **Boolean** |  | [optional] 
+**creation_date** | **String** |  | [optional] [readonly] 
+**modification_date** | **String** |  | [optional] [readonly] 
+**creation_username** | **String** |  | [optional] [readonly] 
+**modification_username** | **String** |  | [optional] [readonly] 
+**status** | **String** |  | [optional] [readonly] 
+**job_started** | **String** |  | [optional] [readonly] 
+**job_finished** | **String** |  | [optional] [readonly] 
+**processed_size** | **Integer** |  | [optional] [readonly] 
+**to_process_size** | **Integer** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::Task.new(id: null,
+                                 name: null,
+                                 comment: null,
+                                 workflow_type: null,
+                                 workflow_action: null,
+                                 source_type: null,
+                                 destination_type: null,
+                                 priority: null,
+                                 conflict_resolution: null,
+                                 action: null,
+                                 activate: null,
+                                 creation_date: null,
+                                 modification_date: null,
+                                 creation_username: null,
+                                 modification_username: null,
+                                 status: null,
+                                 job_started: null,
+                                 job_finished: null,
+                                 processed_size: null,
+                                 to_process_size: null)
+```
+
+

data/docs/TaskCallback.md

@@ -0,0 +1,21 @@
+# Nodeum::TaskCallback
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** |  | [optional] [readonly] 
+**type** | **String** |  | [optional] 
+**script** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TaskCallback.new(id: null,
+                                 type: null,
+                                 script: null)
+```
+
+

data/docs/TaskCallbackCollection.md

@@ -0,0 +1,19 @@
+# Nodeum::TaskCallbackCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] [readonly] 
+**task_callbacks** | [**Array<TaskCallback>**](TaskCallback.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TaskCallbackCollection.new(count: 1,
+                                 task_callbacks: null)
+```
+
+

data/docs/TaskCallbacksApi.md

@@ -0,0 +1,326 @@
+# Nodeum::TaskCallbacksApi
+
+All URIs are relative to *http://localhost/api/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_task_callback**](TaskCallbacksApi.md#create_task_callback) | **POST** /tasks/{task_id}/task_callbacks | Creates a new task callback.
+[**destroy_task_callback**](TaskCallbacksApi.md#destroy_task_callback) | **DELETE** /tasks/{task_id}/task_callbacks/{task_callback_id} | Destroys a specific task callback.
+[**index_task_callbacks**](TaskCallbacksApi.md#index_task_callbacks) | **GET** /tasks/{task_id}/task_callbacks | Lists all task callbacks.
+[**show_task_callback**](TaskCallbacksApi.md#show_task_callback) | **GET** /tasks/{task_id}/task_callbacks/{task_callback_id} | Displays a specific task callback.
+[**update_task_callback**](TaskCallbacksApi.md#update_task_callback) | **PUT** /tasks/{task_id}/task_callbacks/{task_callback_id} | Updates a specific task callback.
+
+
+
+## create_task_callback
+
+> TaskCallback create_task_callback(task_id, task_callback_body)
+
+Creates a new task callback.
+
+**API Key Scope**: task_callbacks / 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::TaskCallbacksApi.new
+task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
+task_callback_body = Nodeum::TaskCallback.new # TaskCallback | 
+
+begin
+  #Creates a new task callback.
+  result = api_instance.create_task_callback(task_id, task_callback_body)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling TaskCallbacksApi->create_task_callback: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. | 
+ **task_callback_body** | [**TaskCallback**](TaskCallback.md)|  | 
+
+### Return type
+
+[**TaskCallback**](TaskCallback.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## destroy_task_callback
+
+> destroy_task_callback(task_id, task_callback_id)
+
+Destroys a specific task callback.
+
+**API Key Scope**: task_callbacks / 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::TaskCallbacksApi.new
+task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
+task_callback_id = 56 # Integer | Numeric ID of task callback.
+
+begin
+  #Destroys a specific task callback.
+  api_instance.destroy_task_callback(task_id, task_callback_id)
+rescue Nodeum::ApiError => e
+  puts "Exception when calling TaskCallbacksApi->destroy_task_callback: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. | 
+ **task_callback_id** | **Integer**| Numeric ID of task callback. | 
+
+### 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_task_callbacks
+
+> TaskCallbackCollection index_task_callbacks(task_id, opts)
+
+Lists all task callbacks.
+
+**API Key Scope**: task_callbacks / 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::TaskCallbacksApi.new
+task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
+opts = {
+  limit: 56, # Integer | The number of items to display for pagination.
+  offset: 56, # Integer | The number of items to skip for pagination.
+  sort_by: ['sort_by_example'], # Array<String> | Sort results by attribute.  Can sort on multiple attributes, separated by `|`. Order direction can be suffixing the attribute by either `:asc` (default) or `:desc`.
+  id: 'id_example', # String | Filter on id
+  type: 'type_example', # String | Filter on type
+  script: 'script_example' # String | Filter on task callback script
+}
+
+begin
+  #Lists all task callbacks.
+  result = api_instance.index_task_callbacks(task_id, opts)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling TaskCallbacksApi->index_task_callbacks: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. | 
+ **limit** | **Integer**| The number of items to display for pagination. | [optional] 
+ **offset** | **Integer**| The number of items to skip for pagination. | [optional] 
+ **sort_by** | [**Array&lt;String&gt;**](String.md)| Sort results by attribute.  Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. | [optional] 
+ **id** | **String**| Filter on id | [optional] 
+ **type** | **String**| Filter on type | [optional] 
+ **script** | **String**| Filter on task callback script | [optional] 
+
+### Return type
+
+[**TaskCallbackCollection**](TaskCallbackCollection.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## show_task_callback
+
+> TaskCallback show_task_callback(task_id, task_callback_id)
+
+Displays a specific task callback.
+
+**API Key Scope**: task_callbacks / 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::TaskCallbacksApi.new
+task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
+task_callback_id = 56 # Integer | Numeric ID of task callback.
+
+begin
+  #Displays a specific task callback.
+  result = api_instance.show_task_callback(task_id, task_callback_id)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling TaskCallbacksApi->show_task_callback: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. | 
+ **task_callback_id** | **Integer**| Numeric ID of task callback. | 
+
+### Return type
+
+[**TaskCallback**](TaskCallback.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_task_callback
+
+> TaskCallback update_task_callback(task_id, task_callback_id, task_callback_body)
+
+Updates a specific task callback.
+
+**API Key Scope**: task_callbacks / 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::TaskCallbacksApi.new
+task_id = 'task_id_example' # String | Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.
+task_callback_id = 56 # Integer | Numeric ID of task callback.
+task_callback_body = Nodeum::TaskCallback.new # TaskCallback | 
+
+begin
+  #Updates a specific task callback.
+  result = api_instance.update_task_callback(task_id, task_callback_id, task_callback_body)
+  p result
+rescue Nodeum::ApiError => e
+  puts "Exception when calling TaskCallbacksApi->update_task_callback: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **task_id** | **String**| Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. | 
+ **task_callback_id** | **Integer**| Numeric ID of task callback. | 
+ **task_callback_body** | [**TaskCallback**](TaskCallback.md)|  | 
+
+### Return type
+
+[**TaskCallback**](TaskCallback.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/TaskCollection.md

@@ -0,0 +1,19 @@
+# Nodeum::TaskCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] [readonly] 
+**tasks** | [**Array<Task>**](Task.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TaskCollection.new(count: 1,
+                                 tasks: null)
+```
+
+

data/docs/TaskDestinationCollection.md

@@ -0,0 +1,19 @@
+# Nodeum::TaskDestinationCollection
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** |  | [optional] [readonly] 
+**task_destinations** | [**Array<TaskDestinationDown>**](TaskDestinationDown.md) |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'Nodeum'
+
+instance = Nodeum::TaskDestinationCollection.new(count: 1,
+                                 task_destinations: null)
+```
+
+