korona_client 1.0.0 → 1.1.0

data/docs/SuppliersApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_supplier**](SuppliersApi.md#get_supplier) | **GET** /accounts/{koronaAccountId}/suppliers/{supplierIdOrNumber} | lists the supplier
+[**get_supplier**](SuppliersApi.md#get_supplier) | **GET** /accounts/{koronaAccountId}/suppliers/{supplierId} | returns the single supplier
 [**get_suppliers**](SuppliersApi.md#get_suppliers) | **GET** /accounts/{koronaAccountId}/suppliers | lists all suppliers
 
 
 # **get_supplier**
-> Supplier get_supplier(korona_account_id, supplier_id_or_number)
+> Supplier get_supplier(korona_account_id, supplier_id)
 
-lists the supplier
+returns the single supplier
 
 
 
@@ -28,14 +28,14 @@ end
 
 api_instance = KoronaClient::SuppliersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-supplier_id_or_number = "supplier_id_or_number_example" # String | id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)
+supplier_id = 'supplier_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the supplier
-  result = api_instance.get_supplier(korona_account_id, supplier_id_or_number)
+  #returns the single supplier
+  result = api_instance.get_supplier(korona_account_id, supplier_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling SuppliersApi->get_supplier: #{e}"
@@ -46,8 +46,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **supplier_id_or_number** | **String**| id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **supplier_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -84,14 +84,15 @@ end
 
 api_instance = KoronaClient::SuppliersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
 opts = { 
   page: 56, # Integer | number of the page to fetch
   size: 56, # Integer | amount of objects to return per page
-  sort: "sort_example", # String | attribute to sort by (multiple separated by comma; max. 5)
+  sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
   revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
-  include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+  include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
 }
 
 begin
@@ -107,12 +108,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
  **page** | **Integer**| number of the page to fetch | [optional] 
  **size** | **Integer**| amount of objects to return per page | [optional] 
  **sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional] 
  **revision** | **Integer**| last revision number, objects with a greater revision than this will be returned | [optional] 
  **include_deleted** | **BOOLEAN**| indicates deleted objects should be loaded or not (default: false) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
 
 ### Return type
 

data/docs/TagsApi.md

@@ -4,14 +4,190 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_tag**](TagsApi.md#get_tag) | **GET** /accounts/{koronaAccountId}/tags/{tagId} | lists the info text
-[**get_tags**](TagsApi.md#get_tags) | **GET** /accounts/{koronaAccountId}/tags | lists all info texts
+[**add_tags**](TagsApi.md#add_tags) | **POST** /accounts/{koronaAccountId}/tags | adds a batch of new tags
+[**delete_tag**](TagsApi.md#delete_tag) | **DELETE** /accounts/{koronaAccountId}/tags/{tagId} | deletes the single tag
+[**delete_tags**](TagsApi.md#delete_tags) | **DELETE** /accounts/{koronaAccountId}/tags | deletes a batch of tags
+[**get_tag**](TagsApi.md#get_tag) | **GET** /accounts/{koronaAccountId}/tags/{tagId} | returns the single tag
+[**get_tags**](TagsApi.md#get_tags) | **GET** /accounts/{koronaAccountId}/tags | lists all tags
+[**update_tag**](TagsApi.md#update_tag) | **PATCH** /accounts/{koronaAccountId}/tags/{tagId} | updates the single tag
+[**update_tags**](TagsApi.md#update_tags) | **PATCH** /accounts/{koronaAccountId}/tags | updates a batch of tags
+
+
+# **add_tags**
+> Array<AddOrUpdateResult> add_tags(korona_account_id, body, opts)
+
+adds a batch of new tags
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TagsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::Tag.new] # Array<Tag> | array of new tags
+
+opts = { 
+  upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new tags
+  result = api_instance.add_tags(korona_account_id, body, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TagsApi->add_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Tag&gt;**](Tag.md)| array of new tags | 
+ **upsert** | **BOOLEAN**| when set to true, updates the object instead of generating a already-exists-error | [optional] 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_tag**
+> delete_tag(korona_account_id, tag_id)
+
+deletes the single tag
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TagsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+tag_id = 'tag_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #deletes the single tag
+  api_instance.delete_tag(korona_account_id, tag_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TagsApi->delete_tag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **tag_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_tags**
+> Array&lt;AddOrUpdateResult&gt; delete_tags(korona_account_id, body)
+
+deletes a batch of tags
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TagsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::Tag.new] # Array<Tag> | array of existing tags (id or number required)
+
+
+begin
+  #deletes a batch of tags
+  result = api_instance.delete_tags(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TagsApi->delete_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Tag&gt;**](Tag.md)| array of existing tags (id or number required) | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
 
 
 # **get_tag**
 > Tag get_tag(korona_account_id, tag_id)
 
-lists the info text
+returns the single tag
 
 
 
@@ -28,13 +204,13 @@ end
 
 api_instance = KoronaClient::TagsApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-tag_id = "tag_id_example" # String | id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number)
+tag_id = 'tag_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the info text
+  #returns the single tag
   result = api_instance.get_tag(korona_account_id, tag_id)
   p result
 rescue KoronaClient::ApiError => e
@@ -46,8 +222,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **tag_id** | **String**| id or number of the related object (important: if a number should match the uuid-format, the system will lookup for an id instead of a number) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **tag_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -67,7 +243,7 @@ Name | Type | Description  | Notes
 # **get_tags**
 > ResultListTag get_tags(korona_account_id, opts)
 
-lists all info texts
+lists all tags
 
 
 
@@ -84,18 +260,18 @@ end
 
 api_instance = KoronaClient::TagsApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
 opts = { 
   page: 56, # Integer | number of the page to fetch
   size: 56, # Integer | amount of objects to return per page
-  sort: "sort_example", # String | attribute to sort by (multiple separated by comma; max. 5)
+  sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
   revision: 789, # Integer | last revision number, objects with a greater revision than this will be returned
   include_deleted: true # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
 }
 
 begin
-  #lists all info texts
+  #lists all tags
   result = api_instance.get_tags(korona_account_id, opts)
   p result
 rescue KoronaClient::ApiError => e
@@ -107,7 +283,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
  **page** | **Integer**| number of the page to fetch | [optional] 
  **size** | **Integer**| amount of objects to return per page | [optional] 
  **sort** | **String**| attribute to sort by (multiple separated by comma; max. 5) | [optional] 
@@ -129,3 +305,117 @@ Name | Type | Description  | Notes
 
 
 
+# **update_tag**
+> update_tag(korona_account_id, tag_id, body)
+
+updates the single tag
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TagsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+tag_id = 'tag_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = KoronaClient::Tag.new # Tag | the properties to update of the tag
+
+
+begin
+  #updates the single tag
+  api_instance.update_tag(korona_account_id, tag_id, body)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TagsApi->update_tag: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **tag_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Tag**](Tag.md)| the properties to update of the tag | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_tags**
+> Array&lt;AddOrUpdateResult&gt; update_tags(korona_account_id, body)
+
+updates a batch of tags
+
+
+
+### Example
+```ruby
+# load the gem
+require 'korona_client'
+# setup authorization
+KoronaClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaClient::TagsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::Tag.new] # Array<Tag> | array of existing tags (id or number required)
+
+
+begin
+  #updates a batch of tags
+  result = api_instance.update_tags(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling TagsApi->update_tags: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Tag&gt;**](Tag.md)| array of existing tags (id or number required) | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+