korona_client 1.0.0 → 1.1.0

data/docs/Attendance.md

@@ -0,0 +1,17 @@
+# KoronaClient::Attendance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | indicates whether the object is active for use or not | [optional] 
+**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] 
+**category_name** | **String** |  | [optional] 
+**category_id** | **String** |  | [optional] 
+**creation_time** | **DateTime** |  | [optional] 
+**event** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**expiration_time** | **DateTime** |  | [optional] 
+**seats** | **Integer** |  | [optional] 
+
+

data/docs/Cashier.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **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] 
 **_alias** | **String** |  | [optional] 
+**deactivated** | **BOOLEAN** |  | [optional] 
 **email** | **String** |  | [optional] 
 **firstname** | **String** |  | [optional] 
 **gender** | **String** |  | [optional] 

data/docs/CashiersApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_cashier**](CashiersApi.md#get_cashier) | **GET** /accounts/{koronaAccountId}/cashiers/{cashierIdOrNumber} | lists the cashier
+[**get_cashier**](CashiersApi.md#get_cashier) | **GET** /accounts/{koronaAccountId}/cashiers/{cashierId} | returns the single cashier
 [**get_cashiers**](CashiersApi.md#get_cashiers) | **GET** /accounts/{koronaAccountId}/cashiers | lists all cashiers
 
 
 # **get_cashier**
-> Cashier get_cashier(korona_account_id, cashier_id_or_number)
+> Cashier get_cashier(korona_account_id, cashier_id)
 
-lists the cashier
+returns the single cashier
 
 
 
@@ -28,14 +28,14 @@ end
 
 api_instance = KoronaClient::CashiersApi.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
 
-cashier_id_or_number = "cashier_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)
+cashier_id = 'cashier_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the cashier
-  result = api_instance.get_cashier(korona_account_id, cashier_id_or_number)
+  #returns the single cashier
+  result = api_instance.get_cashier(korona_account_id, cashier_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CashiersApi->get_cashier: #{e}"
@@ -46,8 +46,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **cashier_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 | 
+ **cashier_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -84,14 +84,15 @@ end
 
 api_instance = KoronaClient::CashiersApi.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/Category.md

@@ -5,5 +5,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** |  | [optional] 
 **product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**external_id** | **String** |  | [optional] 
 
 

data/docs/CommodityGroupsApi.md

@@ -0,0 +1,423 @@
+# KoronaClient::CommodityGroupsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_commodity_groups**](CommodityGroupsApi.md#add_commodity_groups) | **POST** /accounts/{koronaAccountId}/commodityGroups | adds a batch of new commodity groups
+[**delete_commodity_group**](CommodityGroupsApi.md#delete_commodity_group) | **DELETE** /accounts/{koronaAccountId}/commodityGroups/{commodityGroupId} | deletes the single commodity group
+[**delete_commodity_groups**](CommodityGroupsApi.md#delete_commodity_groups) | **DELETE** /accounts/{koronaAccountId}/commodityGroups | deletes a batch of commodity groups
+[**get_commodity_group**](CommodityGroupsApi.md#get_commodity_group) | **GET** /accounts/{koronaAccountId}/commodityGroups/{commodityGroupId} | returns the single commodity group
+[**get_commodity_groups**](CommodityGroupsApi.md#get_commodity_groups) | **GET** /accounts/{koronaAccountId}/commodityGroups | lists all commodity groups
+[**update_commodity_group**](CommodityGroupsApi.md#update_commodity_group) | **PATCH** /accounts/{koronaAccountId}/commodityGroups/{commodityGroupId} | updates the single commodity group
+[**update_commodity_groups**](CommodityGroupsApi.md#update_commodity_groups) | **PATCH** /accounts/{koronaAccountId}/commodityGroups | updates a batch of commodity groups
+
+
+# **add_commodity_groups**
+> Array<AddOrUpdateResult> add_commodity_groups(korona_account_id, body, opts)
+
+adds a batch of new commodity groups
+
+
+
+### 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::CommodityGroupsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::CommodityGroup.new] # Array<CommodityGroup> | an array of new commodity groups
+
+opts = { 
+  upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new commodity groups
+  result = api_instance.add_commodity_groups(korona_account_id, body, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->add_commodity_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;CommodityGroup&gt;**](CommodityGroup.md)| an array of new commodity groups | 
+ **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_commodity_group**
+> delete_commodity_group(korona_account_id, commodity_group_id)
+
+deletes the single commodity group
+
+
+
+### 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::CommodityGroupsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+commodity_group_id = 'commodity_group_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #deletes the single commodity group
+  api_instance.delete_commodity_group(korona_account_id, commodity_group_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->delete_commodity_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **commodity_group_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_commodity_groups**
+> Array&lt;AddOrUpdateResult&gt; delete_commodity_groups(korona_account_id, body)
+
+deletes a batch of commodity groups
+
+
+
+### 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::CommodityGroupsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::CommodityGroup.new] # Array<CommodityGroup> | array of existing commodity groups (id or number required)
+
+
+begin
+  #deletes a batch of commodity groups
+  result = api_instance.delete_commodity_groups(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->delete_commodity_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;CommodityGroup&gt;**](CommodityGroup.md)| array of existing commodity groups (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_commodity_group**
+> CommodityGroup get_commodity_group(korona_account_id, commodity_group_id)
+
+returns the single commodity group
+
+
+
+### 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::CommodityGroupsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+commodity_group_id = 'commodity_group_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns the single commodity group
+  result = api_instance.get_commodity_group(korona_account_id, commodity_group_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->get_commodity_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **commodity_group_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**CommodityGroup**](CommodityGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_commodity_groups**
+> ResultListCommodityGroup get_commodity_groups(korona_account_id, opts)
+
+lists all commodity groups
+
+
+
+### 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::CommodityGroupsApi.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: 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)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all commodity groups
+  result = api_instance.get_commodity_groups(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->get_commodity_groups: #{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
+
+[**ResultListCommodityGroup**](ResultListCommodityGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_commodity_group**
+> update_commodity_group(korona_account_id, commodity_group_id, body)
+
+updates the single commodity group
+
+
+
+### 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::CommodityGroupsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+commodity_group_id = 'commodity_group_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = KoronaClient::CommodityGroup.new # CommodityGroup | the properties to update of the commodity group
+
+
+begin
+  #updates the single commodity group
+  api_instance.update_commodity_group(korona_account_id, commodity_group_id, body)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->update_commodity_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **commodity_group_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**CommodityGroup**](CommodityGroup.md)| the properties to update of the commodity group | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_commodity_groups**
+> Array&lt;AddOrUpdateResult&gt; update_commodity_groups(korona_account_id, body)
+
+updates a batch of commodity groups
+
+
+
+### 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::CommodityGroupsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::CommodityGroup.new] # Array<CommodityGroup> | array of existing commodity groups (id or number required)
+
+
+begin
+  #updates a batch of commodity groups
+  result = api_instance.update_commodity_groups(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CommodityGroupsApi->update_commodity_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;CommodityGroup&gt;**](CommodityGroup.md)| array of existing commodity groups (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
+
+
+