korona_client 1.0.0 → 1.1.0

data/docs/Pos.md

@@ -11,15 +11,17 @@ Name | Type | Description | Notes
 **coupling_id** | **String** |  | [optional] 
 **default_customer_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
 **default_payment_method** | [**ModelReference**](ModelReference.md) |  | [optional] 
-**device_information** | [**DeviceInformation**](DeviceInformation.md) |  | [optional] 
+**device_information** | [**DeviceInformation**](DeviceInformation.md) | only for updating-purposes through PATCH, not shown on GET requests. | [optional] 
 **external** | **BOOLEAN** |  | [optional] 
-**last_receipt_number** | **String** |  | [optional] 
-**last_z_count** | **Integer** |  | [optional] 
+**last_receipt_number** | **String** | last receipt number - only shown if external=true and coupled=false; usable for client-side receipt counter. | [optional] 
+**last_z_count** | **Integer** | last zcount property - only shown if external=true and coupled=false; usable for client-side zcount. | [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] 
+**contra_account** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**revenue_account** | [**ModelReference**](ModelReference.md) |  | [optional] 
 
 

data/docs/PriceGroupsApi.md

@@ -4,14 +4,14 @@ 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_group**](PriceGroupsApi.md#get_price_group) | **GET** /accounts/{koronaAccountId}/priceGroups/{priceGroupId} | returns the single 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)
+> PriceGroup get_price_group(korona_account_id, price_group_id)
 
-lists the price group
+returns the single price group
 
 
 
@@ -28,14 +28,14 @@ end
 
 api_instance = KoronaClient::PriceGroupsApi.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
 
-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)
+price_group_id = 'price_group_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the price group
-  result = api_instance.get_price_group(korona_account_id, price_group_id_or_number)
+  #returns the single price group
+  result = api_instance.get_price_group(korona_account_id, price_group_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling PriceGroupsApi->get_price_group: #{e}"
@@ -46,8 +46,8 @@ end
 
 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) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **price_group_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -84,14 +84,15 @@ end
 
 api_instance = KoronaClient::PriceGroupsApi.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/Product.md

@@ -44,6 +44,8 @@ Name | Type | Description | Notes
 **tags** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] 
 **ticket_definition** | [**ModelReference**](ModelReference.md) |  | [optional] 
 **track_inventory** | **BOOLEAN** |  | [optional] 
+**media_urls** | [**Array<MediaUrl>**](MediaUrl.md) |  | [optional] 
+**quantity_denomination** | **Float** |  | [optional] 
 **stock_return_unsellable** | **BOOLEAN** |  | [optional] 
 
 

data/docs/ProductsApi.md

@@ -5,16 +5,17 @@ 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)
+[**delete_product**](ProductsApi.md#delete_product) | **DELETE** /accounts/{koronaAccountId}/products/{productId} | deletes the single product
+[**delete_products**](ProductsApi.md#delete_products) | **DELETE** /accounts/{koronaAccountId}/products | deletes a batch of products
+[**get_product**](ProductsApi.md#get_product) | **GET** /accounts/{koronaAccountId}/products/{productId} | returns the single product
+[**get_product_stocks**](ProductsApi.md#get_product_stocks) | **GET** /accounts/{koronaAccountId}/products/{productId}/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
+[**update_product**](ProductsApi.md#update_product) | **PATCH** /accounts/{koronaAccountId}/products/{productId} | updates the single product
+[**update_products**](ProductsApi.md#update_products) | **PATCH** /accounts/{koronaAccountId}/products | updates a batch of products
 
 
 # **add_products**
-> Array<AddOrUpdateResult> add_products(korona_account_id, body)
+> Array<AddOrUpdateResult> add_products(korona_account_id, body, opts)
 
 adds a batch of new products
 
@@ -33,14 +34,17 @@ end
 
 api_instance = KoronaClient::ProductsApi.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::Product.new] # Array<Product> | a array of new products
+body = [KoronaClient::Product.new] # Array<Product> | array of new products
 
+opts = { 
+  upsert: true # BOOLEAN | when set to true, updates the object instead of generating a already-exists-error
+}
 
 begin
   #adds a batch of new products
-  result = api_instance.add_products(korona_account_id, body)
+  result = api_instance.add_products(korona_account_id, body, opts)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling ProductsApi->add_products: #{e}"
@@ -51,8 +55,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **body** | [**Array&lt;Product&gt;**](Product.md)| a array of new products | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Product&gt;**](Product.md)| array of new products | 
+ **upsert** | **BOOLEAN**| when set to true, updates the object instead of generating a already-exists-error | [optional] 
 
 ### Return type
 
@@ -70,9 +75,9 @@ Name | Type | Description  | Notes
 
 
 # **delete_product**
-> delete_product(korona_account_id, product_id_or_number)
+> delete_product(korona_account_id, product_id)
 
-deletes the product
+deletes the single product
 
 
 
@@ -89,14 +94,14 @@ end
 
 api_instance = KoronaClient::ProductsApi.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
 
-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)
+product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #deletes the product
-  api_instance.delete_product(korona_account_id, product_id_or_number)
+  #deletes the single product
+  api_instance.delete_product(korona_account_id, product_id)
 rescue KoronaClient::ApiError => e
   puts "Exception when calling ProductsApi->delete_product: #{e}"
 end
@@ -106,8 +111,8 @@ end
 
 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) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **product_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -124,10 +129,66 @@ nil (empty response body)
 
 
 
+# **delete_products**
+> Array&lt;AddOrUpdateResult&gt; delete_products(korona_account_id, body)
+
+deletes a batch of 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 | account id of the KORONA.cloud account
+
+body = [KoronaClient::Product.new] # Array<Product> | array of existing products (id or number required)
+
+
+begin
+  #deletes a batch of products
+  result = api_instance.delete_products(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ProductsApi->delete_products: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Product&gt;**](Product.md)| array of existing products (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_product**
-> Product get_product(korona_account_id, product_id_or_number)
+> Product get_product(korona_account_id, product_id)
 
-lists the product
+returns the single product
 
 
 
@@ -144,14 +205,14 @@ end
 
 api_instance = KoronaClient::ProductsApi.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
 
-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)
+product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the product
-  result = api_instance.get_product(korona_account_id, product_id_or_number)
+  #returns the single product
+  result = api_instance.get_product(korona_account_id, product_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling ProductsApi->get_product: #{e}"
@@ -162,8 +223,8 @@ end
 
 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) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **product_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -181,7 +242,7 @@ Name | Type | Description  | Notes
 
 
 # **get_product_stocks**
-> ResultListProductStock get_product_stocks(korona_account_id, product_id_or_number, opts)
+> ResultListProductStock get_product_stocks(korona_account_id, product_id, opts)
 
 lists the product stocks in different warehouses (KORONA.retail required)
 
@@ -200,20 +261,20 @@ end
 
 api_instance = KoronaClient::ProductsApi.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
 
-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)
+product_id = 'product_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)
+  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)
+  result = api_instance.get_product_stocks(korona_account_id, product_id, opts)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling ProductsApi->get_product_stocks: #{e}"
@@ -224,8 +285,8 @@ end
 
 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) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **product_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] 
@@ -266,18 +327,19 @@ end
 
 api_instance = KoronaClient::ProductsApi.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)
-  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
+  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 to filter by
+  assortment: 'assortment_example', # String | assortment id to filter by
+  tag: 'tag_example', # String | tag id to filter by
+  number: 'number_example' # String | number of the related object
 }
 
 begin
@@ -293,16 +355,17 @@ 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] 
  **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] 
+ **commodity_group** | **String**| commodity group id to filter by | [optional] 
+ **assortment** | **String**| assortment id to filter by | [optional] 
+ **tag** | **String**| tag id to filter by | [optional] 
+ **number** | **String**| number of the related object | [optional] 
 
 ### Return type
 
@@ -320,9 +383,9 @@ Name | Type | Description  | Notes
 
 
 # **update_product**
-> update_product(korona_account_id, product_id_or_number, body)
+> update_product(korona_account_id, product_id, body)
 
-changes the product
+updates the single product
 
 if [number] is set, the number of the object will change and the resource location as well
 
@@ -339,16 +402,16 @@ end
 
 api_instance = KoronaClient::ProductsApi.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
 
-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)
+product_id = 'product_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 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)
+  #updates the single product
+  api_instance.update_product(korona_account_id, product_id, body)
 rescue KoronaClient::ApiError => e
   puts "Exception when calling ProductsApi->update_product: #{e}"
 end
@@ -358,8 +421,8 @@ end
 
 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) | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **product_id** | **String**| id of the related object (important: id should match the uuid-format) | 
  **body** | [**Product**](Product.md)| the properties to update of the product | 
 
 ### Return type
@@ -380,7 +443,7 @@ nil (empty response body)
 # **update_products**
 > Array&lt;AddOrUpdateResult&gt; update_products(korona_account_id, body)
 
-changes a batch of products
+updates a batch of products
 
 [number] must be set in the objects, otherwise the object cannot be updated
 
@@ -397,13 +460,13 @@ end
 
 api_instance = KoronaClient::ProductsApi.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::Product.new] # Array<Product> | a array of existing products
+body = [KoronaClient::Product.new] # Array<Product> | an array of existing products
 
 
 begin
-  #changes a batch of products
+  #updates a batch of products
   result = api_instance.update_products(korona_account_id, body)
   p result
 rescue KoronaClient::ApiError => e
@@ -415,8 +478,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **body** | [**Array&lt;Product&gt;**](Product.md)| a array of existing products | 
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Product&gt;**](Product.md)| an array of existing products | 
 
 ### Return type