korona_client 1.0.0

data/docs/Pos.md

@@ -0,0 +1,25 @@
+# KoronaClient::Pos
+
+## 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] 
+**coupled** | **BOOLEAN** |  | [optional] 
+**coupling_id** | **String** |  | [optional] 
+**default_customer_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**default_payment_method** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**device_information** | [**DeviceInformation**](DeviceInformation.md) |  | [optional] 
+**external** | **BOOLEAN** |  | [optional] 
+**last_receipt_number** | **String** |  | [optional] 
+**last_z_count** | **Integer** |  | [optional] 
+**name** | **String** |  | [optional] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**print_footer_lines** | **Hash<String, String>** |  | [optional] 
+**print_header_lines** | **Hash<String, String>** |  | [optional] 
+**receipt_info_texts** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
+**use_alternative_sector** | **BOOLEAN** |  | [optional] 
+
+

data/docs/PriceGroup.md

@@ -0,0 +1,14 @@
+# KoronaClient::PriceGroup
+
+## 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] 
+**currency** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**net_prices** | **BOOLEAN** |  | [optional] 
+
+

data/docs/PriceGroupsApi.md

@@ -0,0 +1,131 @@
+# KoronaClient::PriceGroupsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_price_group**](PriceGroupsApi.md#get_price_group) | **GET** /accounts/{koronaAccountId}/priceGroups/{priceGroupIdOrNumber} | lists the price group
+[**get_price_groups**](PriceGroupsApi.md#get_price_groups) | **GET** /accounts/{koronaAccountId}/priceGroups | lists all price groups
+
+
+# **get_price_group**
+> PriceGroup get_price_group(korona_account_id, price_group_id_or_number)
+
+lists the price 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::PriceGroupsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+price_group_id_or_number = "price_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)
+
+
+begin
+  #lists the price group
+  result = api_instance.get_price_group(korona_account_id, price_group_id_or_number)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling PriceGroupsApi->get_price_group: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **price_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) | 
+
+### Return type
+
+[**PriceGroup**](PriceGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_price_groups**
+> ResultListPriceGroup get_price_groups(korona_account_id, opts)
+
+lists all price 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::PriceGroupsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+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 price groups
+  result = api_instance.get_price_groups(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling PriceGroupsApi->get_price_groups: #{e}"
+end
+```
+
+### Parameters
+
+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] 
+
+### Return type
+
+[**ResultListPriceGroup**](ResultListPriceGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Product.md

@@ -0,0 +1,49 @@
+# KoronaClient::Product
+
+## 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] 
+**alternative_sector** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**assortment** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**codes** | [**Array<ProductCode>**](ProductCode.md) |  | [optional] 
+**commodity_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**conversion** | **BOOLEAN** |  | [optional] 
+**costs** | **Float** |  | [optional] 
+**deactivated** | **BOOLEAN** |  | [optional] 
+**deposit** | **BOOLEAN** |  | [optional] 
+**descriptions** | [**Array<ProductDescription>**](ProductDescription.md) |  | [optional] 
+**discountable** | **BOOLEAN** |  | [optional] 
+**image** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**info_texts** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
+**item_sequence** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**last_purchase_price** | **Float** |  | [optional] 
+**listed** | **BOOLEAN** |  | [optional] 
+**listed_since** | **DateTime** |  | [optional] 
+**max_price** | **Float** |  | [optional] 
+**min_price** | **Float** |  | [optional] 
+**name** | **String** |  | [optional] 
+**packaging_quantity** | **Float** |  | [optional] 
+**packaging_required** | **BOOLEAN** |  | [optional] 
+**packaging_unit** | **String** |  | [optional] 
+**personalization_required** | **BOOLEAN** |  | [optional] 
+**price_changable** | **BOOLEAN** |  | [optional] 
+**prices** | [**Array<ProductPrice>**](ProductPrice.md) |  | [optional] 
+**print_tickets_separately** | **BOOLEAN** |  | [optional] 
+**production_type** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**recommended_retail_price** | **Float** |  | [optional] 
+**related_products** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**sector** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**serial_number_required** | **BOOLEAN** |  | [optional] 
+**subproduct_presentation** | **String** |  | [optional] 
+**subproducts** | [**Array<ProductSubproduct>**](ProductSubproduct.md) |  | [optional] 
+**supplier_prices** | [**Array<ProductSupplierPrice>**](ProductSupplierPrice.md) |  | [optional] 
+**tags** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
+**ticket_definition** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**track_inventory** | **BOOLEAN** |  | [optional] 
+**stock_return_unsellable** | **BOOLEAN** |  | [optional] 
+
+

data/docs/ProductCode.md

@@ -0,0 +1,9 @@
+# KoronaClient::ProductCode
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product_code** | **String** |  | [optional] 
+**container_size** | **Float** |  | [optional] 
+
+

data/docs/ProductDescription.md

@@ -0,0 +1,9 @@
+# KoronaClient::ProductDescription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**text** | **String** |  | [optional] 
+
+

data/docs/ProductPrice.md

@@ -0,0 +1,12 @@
+# KoronaClient::ProductPrice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | [optional] 
+**valid_from** | **DateTime** |  | [optional] 
+**product_code** | **String** |  | [optional] 
+**price_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/ProductStock.md

@@ -0,0 +1,12 @@
+# KoronaClient::ProductStock
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**average_purchase_price** | **Float** |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**revision** | **Integer** |  | [optional] 
+**warehouse** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/ProductSubproduct.md

@@ -0,0 +1,10 @@
+# KoronaClient::ProductSubproduct
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prices** | [**Array<ProductPrice>**](ProductPrice.md) |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**quantity** | **Float** |  | [optional] 
+
+

data/docs/ProductSupplierPrice.md

@@ -0,0 +1,12 @@
+# KoronaClient::ProductSupplierPrice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**supplier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**order_code** | **String** |  | [optional] 
+**value** | **Float** |  | [optional] 
+**container_size** | **Float** |  | [optional] 
+**description** | **String** |  | [optional] 
+
+

data/docs/ProductTransferInvolvedPartyInformation.md

@@ -0,0 +1,13 @@
+# KoronaClient::ProductTransferInvolvedPartyInformation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**buyer** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+**delivery_address** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+**final_recipient** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+**invoice_recipient** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+**supplier** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+**transport_service_provider** | [**ProductTransferInvolvedPartyInformationData**](ProductTransferInvolvedPartyInformationData.md) |  | [optional] 
+
+

data/docs/ProductTransferInvolvedPartyInformationData.md

@@ -0,0 +1,10 @@
+# KoronaClient::ProductTransferInvolvedPartyInformationData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**AddressInformation**](AddressInformation.md) |  | [optional] 
+**company** | **String** |  | [optional] 
+**identification** | [**CompanyIdentification**](CompanyIdentification.md) |  | [optional] 
+
+

data/docs/ProductsApi.md

@@ -0,0 +1,435 @@
+# KoronaClient::ProductsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_products**](ProductsApi.md#add_products) | **POST** /accounts/{koronaAccountId}/products | adds a batch of new products
+[**delete_product**](ProductsApi.md#delete_product) | **DELETE** /accounts/{koronaAccountId}/products/{productIdOrNumber} | deletes the product
+[**get_product**](ProductsApi.md#get_product) | **GET** /accounts/{koronaAccountId}/products/{productIdOrNumber} | lists the product
+[**get_product_stocks**](ProductsApi.md#get_product_stocks) | **GET** /accounts/{koronaAccountId}/products/{productIdOrNumber}/stocks | lists the product stocks in different warehouses (KORONA.retail required)
+[**get_products**](ProductsApi.md#get_products) | **GET** /accounts/{koronaAccountId}/products | lists all products
+[**update_product**](ProductsApi.md#update_product) | **PATCH** /accounts/{koronaAccountId}/products/{productIdOrNumber} | changes the product
+[**update_products**](ProductsApi.md#update_products) | **PATCH** /accounts/{koronaAccountId}/products | changes a batch of products
+
+
+# **add_products**
+> Array<AddOrUpdateResult> add_products(korona_account_id, body)
+
+adds a batch of new products
+
+
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+body = [KoronaClient::Product.new] # Array<Product> | a array of new products
+
+
+begin
+  #adds a batch of new products
+  result = api_instance.add_products(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->add_products: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **body** | [**Array&lt;Product&gt;**](Product.md)| a array of new products | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_product**
+> delete_product(korona_account_id, product_id_or_number)
+
+deletes the product
+
+
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+product_id_or_number = "product_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)
+
+
+begin
+  #deletes the product
+  api_instance.delete_product(korona_account_id, product_id_or_number)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->delete_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **product_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) | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_product**
+> Product get_product(korona_account_id, product_id_or_number)
+
+lists the product
+
+
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+product_id_or_number = "product_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)
+
+
+begin
+  #lists the product
+  result = api_instance.get_product(korona_account_id, product_id_or_number)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->get_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **product_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) | 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_product_stocks**
+> ResultListProductStock get_product_stocks(korona_account_id, product_id_or_number, opts)
+
+lists the product stocks in different warehouses (KORONA.retail required)
+
+
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+product_id_or_number = "product_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)
+
+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
+}
+
+begin
+  #lists the product stocks in different warehouses (KORONA.retail required)
+  result = api_instance.get_product_stocks(korona_account_id, product_id_or_number, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->get_product_stocks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **product_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) | 
+ **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**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_products**
+> ResultListProduct get_products(korona_account_id, opts)
+
+lists all products
+
+
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+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)
+  product_codes: "product_codes_example", # String | at least one product code to filter by (multiple separated by comma; max. 10)
+  commodity_group: "commodity_group_example", # String | commodity group id or number to filter by
+  assortment: "assortment_example", # String | assortment id or number to filter by
+  tag: "tag_example" # String | tag id or number to filter by
+}
+
+begin
+  #lists all products
+  result = api_instance.get_products(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->get_products: #{e}"
+end
+```
+
+### Parameters
+
+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] 
+ **product_codes** | **String**| at least one product code to filter by (multiple separated by comma; max. 10) | [optional] 
+ **commodity_group** | **String**| commodity group id or number to filter by | [optional] 
+ **assortment** | **String**| assortment id or number to filter by | [optional] 
+ **tag** | **String**| tag id or number to filter by | [optional] 
+
+### Return type
+
+[**ResultListProduct**](ResultListProduct.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_product**
+> update_product(korona_account_id, product_id_or_number, body)
+
+changes the product
+
+if [number] is set, the number of the object will change and the resource location as well
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+product_id_or_number = "product_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)
+
+body = KoronaClient::Product.new # Product | the properties to update of the product
+
+
+begin
+  #changes the product
+  api_instance.update_product(korona_account_id, product_id_or_number, body)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->update_product: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **product_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) | 
+ **body** | [**Product**](Product.md)| the properties to update of the product | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_products**
+> Array&lt;AddOrUpdateResult&gt; update_products(korona_account_id, body)
+
+changes a batch of products
+
+[number] must be set in the objects, otherwise the object cannot be updated
+
+### 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::ProductsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+body = [KoronaClient::Product.new] # Array<Product> | a array of existing products
+
+
+begin
+  #changes a batch of products
+  result = api_instance.update_products(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->update_products: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **body** | [**Array&lt;Product&gt;**](Product.md)| a array of existing products | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+