korona_client 1.0.0 → 1.1.0

data/docs/AddOrUpdateResult.md

@@ -5,6 +5,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **action** | **String** |  | [optional] 
 **href** | **String** |  | [optional] 
+**revision** | **Integer** |  | [optional] 
 **message** | **String** |  | [optional] 
 **number** | **String** |  | [optional] 
 **status** | **String** |  | [optional] 

data/docs/AdditionalInfo.md

@@ -0,0 +1,9 @@
+# KoronaClient::AdditionalInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** |  | [optional] 
+**type** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/AdditionalReceiptInfoType.md

@@ -0,0 +1,22 @@
+# KoronaClient::AdditionalReceiptInfoType
+
+## 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] 
+**cashier_input_required** | **BOOLEAN** |  | [optional] 
+**customer_groups** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
+**description** | **String** |  | [optional] 
+**min_item_quantity** | **Float** |  | [optional] 
+**min_total** | **Float** |  | [optional] 
+**name** | **String** |  | [optional] 
+**options** | **Array<String>** |  | [optional] 
+**organizational_units** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
+**required** | **BOOLEAN** |  | [optional] 
+**tag** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**validity** | [**Validity**](Validity.md) |  | [optional] 
+
+

data/docs/AdditionalReceiptInfoTypesApi.md

@@ -0,0 +1,133 @@
+# KoronaClient::AdditionalReceiptInfoTypesApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_additional_receipt_info_type**](AdditionalReceiptInfoTypesApi.md#get_additional_receipt_info_type) | **GET** /accounts/{koronaAccountId}/additionalReceiptInfoTypes/{additionalReceiptInfoTypeId} | returns the single additional receipt info type
+[**get_additional_receipt_info_types**](AdditionalReceiptInfoTypesApi.md#get_additional_receipt_info_types) | **GET** /accounts/{koronaAccountId}/additionalReceiptInfoTypes | lists all additional receipt info types
+
+
+# **get_additional_receipt_info_type**
+> AdditionalReceiptInfoType get_additional_receipt_info_type(korona_account_id, additional_receipt_info_type_id)
+
+returns the single additional receipt info type
+
+
+
+### 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::AdditionalReceiptInfoTypesApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+additional_receipt_info_type_id = 'additional_receipt_info_type_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns the single additional receipt info type
+  result = api_instance.get_additional_receipt_info_type(korona_account_id, additional_receipt_info_type_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling AdditionalReceiptInfoTypesApi->get_additional_receipt_info_type: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **additional_receipt_info_type_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**AdditionalReceiptInfoType**](AdditionalReceiptInfoType.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_additional_receipt_info_types**
+> ResultListAdditionalReceiptInfoType get_additional_receipt_info_types(korona_account_id, opts)
+
+lists all additional receipt info types
+
+
+
+### 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::AdditionalReceiptInfoTypesApi.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 additional receipt info types
+  result = api_instance.get_additional_receipt_info_types(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling AdditionalReceiptInfoTypesApi->get_additional_receipt_info_types: #{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
+
+[**ResultListAdditionalReceiptInfoType**](ResultListAdditionalReceiptInfoType.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AssortmentsApi.md

@@ -4,16 +4,190 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_assortment**](AssortmentsApi.md#get_assortment) | **GET** /accounts/{koronaAccountId}/assortments/{assortmentIdOrNumber} | lists the assortment
+[**add_assortments**](AssortmentsApi.md#add_assortments) | **POST** /accounts/{koronaAccountId}/assortments | adds a batch of new assortments
+[**delete_assortment**](AssortmentsApi.md#delete_assortment) | **DELETE** /accounts/{koronaAccountId}/assortments/{assortmentId} | deletes the single assortment
+[**delete_assortments**](AssortmentsApi.md#delete_assortments) | **DELETE** /accounts/{koronaAccountId}/assortments | deletes a batch of assortments
+[**get_assortment**](AssortmentsApi.md#get_assortment) | **GET** /accounts/{koronaAccountId}/assortments/{assortmentId} | returns the single assortment
 [**get_assortments**](AssortmentsApi.md#get_assortments) | **GET** /accounts/{koronaAccountId}/assortments | lists all assortments
-[**get_commodity_group**](AssortmentsApi.md#get_commodity_group) | **GET** /accounts/{koronaAccountId}/commodityGroups/{commodityGroupIdOrNumber} | lists the commodity group
-[**get_commodity_groups**](AssortmentsApi.md#get_commodity_groups) | **GET** /accounts/{koronaAccountId}/commodityGroups | lists all commodity groups
+[**update_assortment**](AssortmentsApi.md#update_assortment) | **PATCH** /accounts/{koronaAccountId}/assortments/{assortmentId} | updates the single assortment
+[**update_assortments**](AssortmentsApi.md#update_assortments) | **PATCH** /accounts/{koronaAccountId}/assortments | updates a batch of assortments
+
+
+# **add_assortments**
+> Array<AddOrUpdateResult> add_assortments(korona_account_id, body, opts)
+
+adds a batch of new assortments
+
+
+
+### 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::AssortmentsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::Assortment.new] # Array<Assortment> | array of new assortments
+
+opts = { 
+  upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new assortments
+  result = api_instance.add_assortments(korona_account_id, body, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling AssortmentsApi->add_assortments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Assortment&gt;**](Assortment.md)| array of new assortments | 
+ **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_assortment**
+> delete_assortment(korona_account_id, assortment_id)
+
+deletes the single assortment
+
+
+
+### 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::AssortmentsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+assortment_id = 'assortment_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #deletes the single assortment
+  api_instance.delete_assortment(korona_account_id, assortment_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling AssortmentsApi->delete_assortment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **assortment_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_assortments**
+> Array&lt;AddOrUpdateResult&gt; delete_assortments(korona_account_id, body)
+
+deletes a batch of assortments
+
+
+
+### 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::AssortmentsApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::Assortment.new] # Array<Assortment> | array of existing assortments (id or number required)
+
+
+begin
+  #deletes a batch of assortments
+  result = api_instance.delete_assortments(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling AssortmentsApi->delete_assortments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Assortment&gt;**](Assortment.md)| array of existing assortments (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_assortment**
-> Assortment get_assortment(korona_account_id, assortment_id_or_number)
+> Assortment get_assortment(korona_account_id, assortment_id)
 
-lists the assortment
+returns the single assortment
 
 
 
@@ -30,14 +204,14 @@ end
 
 api_instance = KoronaClient::AssortmentsApi.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
 
-assortment_id_or_number = "assortment_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)
+assortment_id = 'assortment_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the assortment
-  result = api_instance.get_assortment(korona_account_id, assortment_id_or_number)
+  #returns the single assortment
+  result = api_instance.get_assortment(korona_account_id, assortment_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling AssortmentsApi->get_assortment: #{e}"
@@ -48,8 +222,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **assortment_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 | 
+ **assortment_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -86,14 +260,15 @@ end
 
 api_instance = KoronaClient::AssortmentsApi.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
@@ -109,12 +284,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
 
@@ -131,10 +307,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_commodity_group**
-> CommodityGroup get_commodity_group(korona_account_id, commodity_group_id_or_number)
+# **update_assortment**
+> update_assortment(korona_account_id, assortment_id, body)
 
-lists the commodity group
+updates the single assortment
 
 
 
@@ -151,17 +327,18 @@ end
 
 api_instance = KoronaClient::AssortmentsApi.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
 
-commodity_group_id_or_number = "commodity_group_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)
+assortment_id = 'assortment_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+body = KoronaClient::Assortment.new # Assortment | the properties to update of the assortment
 
 
 begin
-  #lists the commodity group
-  result = api_instance.get_commodity_group(korona_account_id, commodity_group_id_or_number)
-  p result
+  #updates the single assortment
+  api_instance.update_assortment(korona_account_id, assortment_id, body)
 rescue KoronaClient::ApiError => e
-  puts "Exception when calling AssortmentsApi->get_commodity_group: #{e}"
+  puts "Exception when calling AssortmentsApi->update_assortment: #{e}"
 end
 ```
 
@@ -169,12 +346,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **commodity_group_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 | 
+ **assortment_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Assortment**](Assortment.md)| the properties to update of the assortment | 
 
 ### Return type
 
-[**CommodityGroup**](CommodityGroup.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -187,10 +365,10 @@ Name | Type | Description  | Notes
 
 
 
-# **get_commodity_groups**
-> ResultListCommodityGroup get_commodity_groups(korona_account_id, opts)
+# **update_assortments**
+> Array&lt;AddOrUpdateResult&gt; update_assortments(korona_account_id, body)
 
-lists all commodity groups
+updates a batch of assortments
 
 
 
@@ -207,22 +385,17 @@ end
 
 api_instance = KoronaClient::AssortmentsApi.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
+
+body = [KoronaClient::Assortment.new] # Array<Assortment> | array of existing assortments (id or number required)
 
-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)
-}
 
 begin
-  #lists all commodity groups
-  result = api_instance.get_commodity_groups(korona_account_id, opts)
+  #updates a batch of assortments
+  result = api_instance.update_assortments(korona_account_id, body)
   p result
 rescue KoronaClient::ApiError => e
-  puts "Exception when calling AssortmentsApi->get_commodity_groups: #{e}"
+  puts "Exception when calling AssortmentsApi->update_assortments: #{e}"
 end
 ```
 
@@ -230,16 +403,12 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **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] 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Assortment&gt;**](Assortment.md)| array of existing assortments (id or number required) | 
 
 ### Return type
 
-[**ResultListCommodityGroup**](ResultListCommodityGroup.md)
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
 
 ### Authorization