korona-cloud-client 1.0.0

data/docs/Pos.md

@@ -0,0 +1,55 @@
+# KoronaCloudClient::Pos
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**coupled** | **Boolean** |  | [optional] [readonly] 
+**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] [readonly] 
+**last_receipt_number** | **String** | last receipt number - only shown if external=true and coupled=false; usable for client-side receipt counter. | [optional] [readonly] 
+**last_z_count** | **Integer** | last zcount property - only shown if external=true and coupled=false; usable for client-side zcount. | [optional] [readonly] 
+**name** | **String** |  | [optional] [readonly] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**print_footer_lines** | **Hash<String, String>** |  | [optional] [readonly] 
+**print_header_lines** | **Hash<String, String>** |  | [optional] [readonly] 
+**receipt_info_texts** | [**Array<ModelReference>**](ModelReference.md) |  | [optional] [readonly] 
+**use_alternative_sector** | **Boolean** |  | [optional] 
+**contra_account** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**revenue_account** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Pos.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 coupled: null,
+                                 coupling_id: null,
+                                 default_customer_group: null,
+                                 default_payment_method: null,
+                                 device_information: null,
+                                 external: null,
+                                 last_receipt_number: null,
+                                 last_z_count: null,
+                                 name: null,
+                                 organizational_unit: null,
+                                 print_footer_lines: null,
+                                 print_header_lines: null,
+                                 receipt_info_texts: null,
+                                 use_alternative_sector: null,
+                                 contra_account: null,
+                                 revenue_account: null)
+```
+
+

data/docs/PriceGroup.md

@@ -0,0 +1,29 @@
+# KoronaCloudClient::PriceGroup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**currency** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**name** | **String** |  | [optional] 
+**net_prices** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::PriceGroup.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 currency: null,
+                                 name: null,
+                                 net_prices: null)
+```
+
+

data/docs/PriceGroupsApi.md

@@ -0,0 +1,128 @@
+# KoronaCloudClient::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/{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)
+
+returns the single price group
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::PriceGroupsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+price_group_id = 'price_group_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single price group
+  result = api_instance.get_price_group(korona_account_id, price_group_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling PriceGroupsApi->get_price_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**PriceGroup**](PriceGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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-cloud-client'
+# setup authorization
+KoronaCloudClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = KoronaCloudClient::PriceGroupsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+opts = {
+  page: 56, # Integer | number of the page to fetch
+  size: 56, # Integer | amount of objects to return per page
+  sort: 'sort_example', # String | attribute to sort by (multiple separated by comma; max. 5)
+  revision: 56, # Integer | last revision number, objects with a greater revision than this will be returned
+  include_deleted: true, # Boolean | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all price groups
+  result = api_instance.get_price_groups(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling PriceGroupsApi->get_price_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
+
+[**ResultListPriceGroup**](ResultListPriceGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Product.md

@@ -0,0 +1,103 @@
+# KoronaCloudClient::Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **Boolean** | indicates whether the object is active for use or not | [optional] [readonly] 
+**id** | **String** | global object uuid (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) | [optional] 
+**number** | **String** | number of the object, like it is set in backoffice; will be removed when active=false | [optional] 
+**revision** | **Integer** | the revision number of the object. revision numbers are unique per object-type. there is is no object of the same type with identical revision numbers. | [optional] [readonly] 
+**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] 
+**media_urls** | [**Array<MediaUrl>**](MediaUrl.md) |  | [optional] 
+**quantity_denomination** | **Float** |  | [optional] 
+**stock_return_unsellable** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Product.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 alternative_sector: null,
+                                 assortment: null,
+                                 codes: null,
+                                 commodity_group: null,
+                                 conversion: null,
+                                 costs: null,
+                                 deactivated: null,
+                                 deposit: null,
+                                 descriptions: null,
+                                 discountable: null,
+                                 image: null,
+                                 info_texts: null,
+                                 item_sequence: null,
+                                 last_purchase_price: null,
+                                 listed: null,
+                                 listed_since: null,
+                                 max_price: 9999.99,
+                                 min_price: -9999.99,
+                                 name: null,
+                                 packaging_quantity: null,
+                                 packaging_required: null,
+                                 packaging_unit: null,
+                                 personalization_required: null,
+                                 price_changable: null,
+                                 prices: null,
+                                 print_tickets_separately: null,
+                                 production_type: null,
+                                 recommended_retail_price: null,
+                                 related_products: null,
+                                 sector: null,
+                                 serial_number_required: null,
+                                 subproduct_presentation: null,
+                                 subproducts: null,
+                                 supplier_prices: null,
+                                 tags: null,
+                                 ticket_definition: null,
+                                 track_inventory: null,
+                                 media_urls: null,
+                                 quantity_denomination: null,
+                                 stock_return_unsellable: null)
+```
+
+

data/docs/ProductCode.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::ProductCode
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product_code** | **String** |  | [optional] 
+**container_size** | **Float** |  | [optional] 
+**description** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ProductCode.new(product_code: null,
+                                 container_size: null,
+                                 description: null)
+```
+
+

data/docs/ProductDescription.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::ProductDescription
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**text** | **String** |  | [optional] 
+**language** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ProductDescription.new(type: null,
+                                 text: null,
+                                 language: null)
+```
+
+

data/docs/ProductPrice.md

@@ -0,0 +1,25 @@
+# KoronaCloudClient::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] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ProductPrice.new(value: null,
+                                 valid_from: null,
+                                 product_code: null,
+                                 price_group: null,
+                                 organizational_unit: null)
+```
+
+

data/docs/ProductStock.md

@@ -0,0 +1,25 @@
+# KoronaCloudClient::ProductStock
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**average_purchase_price** | **Float** |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**revision** | **Integer** |  | [optional] [readonly] 
+**warehouse** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ProductStock.new(amount: null,
+                                 average_purchase_price: null,
+                                 product: null,
+                                 revision: null,
+                                 warehouse: null)
+```
+
+

data/docs/ProductSubproduct.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::ProductSubproduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prices** | [**Array<ProductPrice>**](ProductPrice.md) |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**quantity** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ProductSubproduct.new(prices: null,
+                                 product: null,
+                                 quantity: null)
+```
+
+

data/docs/ProductSupplierPrice.md

@@ -0,0 +1,25 @@
+# KoronaCloudClient::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] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ProductSupplierPrice.new(supplier: null,
+                                 order_code: null,
+                                 value: null,
+                                 container_size: null,
+                                 description: null)
+```
+
+