korona-cloud-client 1.0.0

data/docs/Supplier.md

@@ -0,0 +1,39 @@
+# KoronaCloudClient::Supplier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**additional_information** | **String** |  | [optional] 
+**address** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+**contact** | [**SupplierContact**](SupplierContact.md) |  | [optional] 
+**contact_person** | [**SupplierContactPerson**](SupplierContactPerson.md) |  | [optional] 
+**customer_number** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**payment** | [**SupplierPaymentInformation**](SupplierPaymentInformation.md) |  | [optional] 
+**return_address** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Supplier.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 additional_information: null,
+                                 address: null,
+                                 contact: null,
+                                 contact_person: null,
+                                 customer_number: null,
+                                 name: null,
+                                 payment: null,
+                                 return_address: null)
+```
+
+

data/docs/SupplierContact.md

@@ -0,0 +1,23 @@
+# KoronaCloudClient::SupplierContact
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | [optional] 
+**fax** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**website** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SupplierContact.new(email: null,
+                                 fax: null,
+                                 phone: null,
+                                 website: null)
+```
+
+

data/docs/SupplierContactPerson.md

@@ -0,0 +1,29 @@
+# KoronaCloudClient::SupplierContactPerson
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** |  | [optional] 
+**fax** | **String** |  | [optional] 
+**firstname** | **String** |  | [optional] 
+**mobile** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**salutation** | **String** |  | [optional] 
+**surname** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SupplierContactPerson.new(email: null,
+                                 fax: null,
+                                 firstname: null,
+                                 mobile: null,
+                                 phone: null,
+                                 salutation: null,
+                                 surname: null)
+```
+
+

data/docs/SupplierPaymentInformation.md

@@ -0,0 +1,33 @@
+# KoronaCloudClient::SupplierPaymentInformation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_number** | **String** |  | [optional] 
+**bank** | **String** |  | [optional] 
+**bank_number** | **String** |  | [optional] 
+**bic** | **String** |  | [optional] 
+**creditor_identifier** | **String** |  | [optional] 
+**currency** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**iban** | **String** |  | [optional] 
+**payment_method** | **String** |  | [optional] 
+**minimum_order_value** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::SupplierPaymentInformation.new(account_number: null,
+                                 bank: null,
+                                 bank_number: null,
+                                 bic: null,
+                                 creditor_identifier: null,
+                                 currency: null,
+                                 iban: null,
+                                 payment_method: null,
+                                 minimum_order_value: null)
+```
+
+

data/docs/SuppliersApi.md

@@ -0,0 +1,128 @@
+# KoronaCloudClient::SuppliersApi
+
+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/{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)
+
+returns the single supplier
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SuppliersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+supplier_id = 'supplier_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single supplier
+  result = api_instance.get_supplier(korona_account_id, supplier_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SuppliersApi->get_supplier: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**Supplier**](Supplier.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_suppliers
+
+> ResultListSupplier get_suppliers(korona_account_id, opts)
+
+lists all suppliers
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::SuppliersApi.new
+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)
+  revision: 56, # 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)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all suppliers
+  result = api_instance.get_suppliers(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling SuppliersApi->get_suppliers: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**ResultListSupplier**](ResultListSupplier.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Tag.md

@@ -0,0 +1,25 @@
+# KoronaCloudClient::Tag
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Tag.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 name: null)
+```
+
+

data/docs/TagsApi.md

@@ -0,0 +1,400 @@
+# KoronaCloudClient::TagsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**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-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::TagsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::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 KoronaCloudClient::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-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::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 KoronaCloudClient::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**: Not defined
+- **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-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::TagsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::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 KoronaCloudClient::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)
+
+returns the single tag
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::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
+  #returns the single tag
+  result = api_instance.get_tag(korona_account_id, tag_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling TagsApi->get_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
+
+[**Tag**](Tag.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_tags
+
+> ResultListTag get_tags(korona_account_id, opts)
+
+lists all tags
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::TagsApi.new
+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)
+  revision: 56, # 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 tags
+  result = api_instance.get_tags(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling TagsApi->get_tags: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+
+### Return type
+
+[**ResultListTag**](ResultListTag.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_tag
+
+> update_tag(korona_account_id, tag_id, body)
+
+updates the single tag
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::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 = KoronaCloudClient::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 KoronaCloudClient::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-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::TagsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::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 KoronaCloudClient::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
+