korona-cloud-client 1.0.0

data/docs/Inventory.md

@@ -0,0 +1,53 @@
+# KoronaCloudClient::Inventory
+
+## 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] 
+**automatic_booking** | **Boolean** |  | [optional] 
+**automatic_booking_after_days** | **Integer** | only if isAutomaticBooking=true | [optional] 
+**check_product_assortment_validity** | **Boolean** |  | [optional] 
+**check_product_listing** | **Boolean** |  | [optional] 
+**create_time** | **DateTime** |  | [optional] 
+**description** | **String** |  | [optional] 
+**execution_days** | **Array<String>** | only if type=PERPETUAL_INVENTORY | [optional] 
+**execution_time** | **DateTime** |  | [optional] 
+**has_booked_receipts** | **Boolean** |  | [optional] 
+**max_products_per_list** | **Integer** | only if type=ANNUAL_INVENTORY | INVENTORY_IRREGULARITY | [optional] 
+**one_commodity_group_per_inventory_list** | **Boolean** | only if type=ANNUAL_INVENTORY | INVENTORY_IRREGULARITY | [optional] 
+**only_negative_product_stocks** | **Boolean** | only if type=INVENTORY_IRREGULARITY | [optional] 
+**organizational_units** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
+**product_filter** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Inventory.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 automatic_booking: null,
+                                 automatic_booking_after_days: null,
+                                 check_product_assortment_validity: null,
+                                 check_product_listing: null,
+                                 create_time: null,
+                                 description: null,
+                                 execution_days: null,
+                                 execution_time: null,
+                                 has_booked_receipts: null,
+                                 max_products_per_list: null,
+                                 one_commodity_group_per_inventory_list: null,
+                                 only_negative_product_stocks: null,
+                                 organizational_units: null,
+                                 product_filter: null,
+                                 type: null)
+```
+
+

data/docs/InventoryList.md

@@ -0,0 +1,45 @@
+# KoronaCloudClient::InventoryList
+
+## 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] 
+**booking_time** | **DateTime** |  | [optional] [readonly] 
+**booking_user** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**create_time** | **DateTime** |  | [optional] [readonly] 
+**description** | **String** |  | [optional] 
+**finish_time** | **DateTime** |  | [optional] [readonly] 
+**inventory** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**modified_time** | **DateTime** |  | [optional] [readonly] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**point_of_sale** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**status** | **String** |  | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::InventoryList.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 booking_time: null,
+                                 booking_user: null,
+                                 cashier: null,
+                                 create_time: null,
+                                 description: null,
+                                 finish_time: null,
+                                 inventory: null,
+                                 modified_time: null,
+                                 organizational_unit: null,
+                                 point_of_sale: null,
+                                 status: null)
+```
+
+

data/docs/InventoryListItem.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::InventoryListItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**average_purchase_price** | **Float** |  | [optional] 
+**index** | **Integer** |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**revision** | **Integer** |  | [optional] [readonly] 
+**stock** | [**InventoryListItemStock**](InventoryListItemStock.md) |  | [optional] 
+**stock_difference_reason** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::InventoryListItem.new(average_purchase_price: null,
+                                 index: null,
+                                 product: null,
+                                 revision: null,
+                                 stock: null,
+                                 stock_difference_reason: null)
+```
+
+

data/docs/InventoryListItemStock.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::InventoryListItemStock
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**actual** | **Float** |  | [optional] 
+**nominal** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::InventoryListItemStock.new(actual: null,
+                                 nominal: null)
+```
+
+

data/docs/KoronaAccount.md

@@ -0,0 +1,35 @@
+# KoronaCloudClient::KoronaAccount
+
+## 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] 
+**active_packages** | **Array<String>** |  | [optional] 
+**address** | [**AddressInformation**](AddressInformation.md) |  | [optional] 
+**cloud_subscription** | [**CloudSubscription**](CloudSubscription.md) |  | [optional] 
+**company** | **String** |  | [optional] 
+**identification** | [**CompanyIdentification**](CompanyIdentification.md) |  | [optional] 
+**test_mode** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::KoronaAccount.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 active_packages: null,
+                                 address: null,
+                                 cloud_subscription: null,
+                                 company: null,
+                                 identification: null,
+                                 test_mode: null)
+```
+
+

data/docs/KoronaAccountApi.md

@@ -0,0 +1,60 @@
+# KoronaCloudClient::KoronaAccountApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_korona_account**](KoronaAccountApi.md#get_korona_account) | **GET** /accounts/{koronaAccountId} | returns the single korona account
+
+
+
+## get_korona_account
+
+> KoronaAccount get_korona_account(korona_account_id)
+
+returns the single korona account
+
+### 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::KoronaAccountApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+begin
+  #returns the single korona account
+  result = api_instance.get_korona_account(korona_account_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling KoronaAccountApi->get_korona_account: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+
+### Return type
+
+[**KoronaAccount**](KoronaAccount.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MediaUrl.md

@@ -0,0 +1,17 @@
+# KoronaCloudClient::MediaUrl
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::MediaUrl.new(url: null)
+```
+
+

data/docs/MethodNotAllowedError.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::MethodNotAllowedError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | a short description of the error in english | [optional] 
+**code** | **String** | the code for client-side evaluation of the error | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::MethodNotAllowedError.new(message: null,
+                                 code: null)
+```
+
+

data/docs/ModelReference.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::ModelReference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx). recommanded to use for linking purposes. will never change. | [optional] 
+**name** | **String** | name, like it is set in backoffice | [optional] 
+**number** | **String** | number, like it is set in backoffice | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ModelReference.new(id: null,
+                                 name: null,
+                                 number: null)
+```
+
+

data/docs/NotFoundError.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::NotFoundError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | a short description of the error in english | [optional] 
+**code** | **String** | the code for client-side evaluation of the error | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::NotFoundError.new(message: null,
+                                 code: null)
+```
+
+

data/docs/OpeningHours.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::OpeningHours
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**week_day** | **String** |  | [optional] 
+**from** | **String** |  | [optional] 
+**to** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::OpeningHours.new(week_day: null,
+                                 from: 13:37,
+                                 to: 13:37)
+```
+
+

data/docs/OrganizationalUnit.md

@@ -0,0 +1,41 @@
+# KoronaCloudClient::OrganizationalUnit
+
+## 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] 
+**address** | [**AddressInformation**](AddressInformation.md) |  | [optional] 
+**economic_zone** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**name** | **String** |  | 
+**parent_organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**price_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**warehouse** | **Boolean** |  | [optional] 
+**cost_center** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**opening_hours** | [**Array<OpeningHours>**](OpeningHours.md) |  | [optional] 
+**eh_number** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::OrganizationalUnit.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 address: null,
+                                 economic_zone: null,
+                                 name: null,
+                                 parent_organizational_unit: null,
+                                 price_group: null,
+                                 warehouse: null,
+                                 cost_center: null,
+                                 opening_hours: null,
+                                 eh_number: null)
+```
+
+

data/docs/OrganizationalUnitsApi.md

@@ -0,0 +1,690 @@
+# KoronaCloudClient::OrganizationalUnitsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_organizational_unit_day_ratings**](OrganizationalUnitsApi.md#add_organizational_unit_day_ratings) | **POST** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings | adds a batch of new day ratings
+[**delete_organizational_unit_day_rating**](OrganizationalUnitsApi.md#delete_organizational_unit_day_rating) | **DELETE** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings/{dayRatingIdOrDate} | deletes the single day rating by its id or date
+[**get_organizational_unit**](OrganizationalUnitsApi.md#get_organizational_unit) | **GET** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId} | returns the single organizational unit
+[**get_organizational_unit_day_rating**](OrganizationalUnitsApi.md#get_organizational_unit_day_rating) | **GET** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings/{dayRatingIdOrDate} | returns the single day rating by its id or date
+[**get_organizational_unit_day_ratings**](OrganizationalUnitsApi.md#get_organizational_unit_day_ratings) | **GET** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings | lists all organizational unit related day ratings
+[**get_organizational_unit_inventory_lists**](OrganizationalUnitsApi.md#get_organizational_unit_inventory_lists) | **GET** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/inventoryLists | lists the inventory lists belonging to the organizational unit (KORONA.retail required)
+[**get_organizational_unit_product_stocks**](OrganizationalUnitsApi.md#get_organizational_unit_product_stocks) | **GET** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/productStocks | lists the product stocks of the organizational unit, in case it contains a warehouse (KORONA.retail required)
+[**get_organizational_unit_stock_receipts**](OrganizationalUnitsApi.md#get_organizational_unit_stock_receipts) | **GET** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/stockReceipts | lists the stock receipts belonging to the organizational unit (KORONA.retail required)
+[**get_organizational_units**](OrganizationalUnitsApi.md#get_organizational_units) | **GET** /accounts/{koronaAccountId}/organizationalUnits | lists all organizational units
+[**update_organizational_unit_day_rating**](OrganizationalUnitsApi.md#update_organizational_unit_day_rating) | **PATCH** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings/{dayRatingIdOrDate} | updates the day rating by its id or date
+[**update_organizational_unit_day_ratings**](OrganizationalUnitsApi.md#update_organizational_unit_day_ratings) | **PATCH** /accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings | updates a batch of day ratings
+
+
+
+## add_organizational_unit_day_ratings
+
+> Array<AddOrUpdateResult> add_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, body)
+
+adds a batch of new day ratings
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+body = [KoronaCloudClient::DayRating.new] # Array<DayRating> | an array of new day ratings
+
+begin
+  #adds a batch of new day ratings
+  result = api_instance.add_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->add_organizational_unit_day_ratings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Array&lt;DayRating&gt;**](DayRating.md)| an array of new day ratings | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_organizational_unit_day_rating
+
+> delete_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date)
+
+deletes the single day rating by its id or date
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+day_rating_id_or_date = 'day_rating_id_or_date_example' # String | the id or date (YYYY-MM-DD) of the day rating
+
+begin
+  #deletes the single day rating by its id or date
+  api_instance.delete_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date)
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->delete_organizational_unit_day_rating: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **day_rating_id_or_date** | **String**| the id or date (YYYY-MM-DD) of the day rating | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit
+
+> OrganizationalUnit get_organizational_unit(korona_account_id, organizational_unit_id)
+
+returns the single organizational unit
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single organizational unit
+  result = api_instance.get_organizational_unit(korona_account_id, organizational_unit_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**OrganizationalUnit**](OrganizationalUnit.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit_day_rating
+
+> DayRating get_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date)
+
+returns the single day rating by its id or date
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+day_rating_id_or_date = 'day_rating_id_or_date_example' # String | the id or date (YYYY-MM-DD) of the day rating
+
+begin
+  #returns the single day rating by its id or date
+  result = api_instance.get_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit_day_rating: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **day_rating_id_or_date** | **String**| the id or date (YYYY-MM-DD) of the day rating | 
+
+### Return type
+
+[**DayRating**](DayRating.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit_day_ratings
+
+> ResultListDayRating get_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, opts)
+
+lists all organizational unit related day ratings
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+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)
+}
+
+begin
+  #lists all organizational unit related day ratings
+  result = api_instance.get_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit_day_ratings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **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] 
+
+### Return type
+
+[**ResultListDayRating**](ResultListDayRating.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit_inventory_lists
+
+> ResultListInventoryList get_organizational_unit_inventory_lists(korona_account_id, organizational_unit_id, opts)
+
+lists the inventory lists belonging to the organizational unit (KORONA.retail required)
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+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)
+  min_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  min_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  booking_status: 'booking_status_example' # String | booking status (possible values: BOOKED, IN_PROGRESS)
+}
+
+begin
+  #lists the inventory lists belonging to the organizational unit (KORONA.retail required)
+  result = api_instance.get_organizational_unit_inventory_lists(korona_account_id, organizational_unit_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit_inventory_lists: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **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] 
+ **min_create_time** | **DateTime**| min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **min_booking_time** | **DateTime**| min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_booking_time** | **DateTime**| max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **booking_status** | **String**| booking status (possible values: BOOKED, IN_PROGRESS) | [optional] 
+
+### Return type
+
+[**ResultListInventoryList**](ResultListInventoryList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit_product_stocks
+
+> ResultListProductStock get_organizational_unit_product_stocks(korona_account_id, organizational_unit_id, opts)
+
+lists the product stocks of the organizational unit, in case it contains a warehouse (KORONA.retail required)
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+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
+}
+
+begin
+  #lists the product stocks of the organizational unit, in case it contains a warehouse (KORONA.retail required)
+  result = api_instance.get_organizational_unit_product_stocks(korona_account_id, organizational_unit_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit_product_stocks: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **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] 
+
+### Return type
+
+[**ResultListProductStock**](ResultListProductStock.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit_stock_receipts
+
+> ResultListStockReceipt get_organizational_unit_stock_receipts(korona_account_id, organizational_unit_id, opts)
+
+lists the stock receipts belonging to the organizational unit (KORONA.retail required)
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+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)
+  min_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  min_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  source_organizational_unit: 'source_organizational_unit_example', # String | source organizational unit
+  booking_status: 'booking_status_example', # String | booking status (possible values: BOOKED, IN_PROGRESS)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists the stock receipts belonging to the organizational unit (KORONA.retail required)
+  result = api_instance.get_organizational_unit_stock_receipts(korona_account_id, organizational_unit_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit_stock_receipts: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **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] 
+ **min_create_time** | **DateTime**| min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **min_booking_time** | **DateTime**| min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_booking_time** | **DateTime**| max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **source_organizational_unit** | **String**| source organizational unit | [optional] 
+ **booking_status** | **String**| booking status (possible values: BOOKED, IN_PROGRESS) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+[**ResultListStockReceipt**](ResultListStockReceipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_units
+
+> ResultListOrganizationalUnit get_organizational_units(korona_account_id, opts)
+
+lists all organizational units
+
+### 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::OrganizationalUnitsApi.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 organizational units
+  result = api_instance.get_organizational_units(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_units: #{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
+
+[**ResultListOrganizationalUnit**](ResultListOrganizationalUnit.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_organizational_unit_day_rating
+
+> update_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date, body)
+
+updates the day rating by its id or date
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+day_rating_id_or_date = 'day_rating_id_or_date_example' # String | the id or date (YYYY-MM-DD) of the day rating
+body = KoronaCloudClient::DayRating.new # DayRating | the properties to update of the day rating
+
+begin
+  #updates the day rating by its id or date
+  api_instance.update_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date, body)
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->update_organizational_unit_day_rating: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **day_rating_id_or_date** | **String**| the id or date (YYYY-MM-DD) of the day rating | 
+ **body** | [**DayRating**](DayRating.md)| the properties to update of the day rating | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_organizational_unit_day_ratings
+
+> Array&lt;AddOrUpdateResult&gt; update_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, body)
+
+updates a batch of day ratings
+
+### 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::OrganizationalUnitsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+organizational_unit_id = 'organizational_unit_id_example' # String | id of the related object (important: id should match the uuid-format)
+body = [KoronaCloudClient::DayRating.new] # Array<DayRating> | an array of new day ratings
+
+begin
+  #updates a batch of day ratings
+  result = api_instance.update_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->update_organizational_unit_day_ratings: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **organizational_unit_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Array&lt;DayRating&gt;**](DayRating.md)| an array of new day ratings | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+