korona_client 1.0.0

data/docs/Rating.md

@@ -0,0 +1,10 @@
+# KoronaClient::Rating
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assortment** | **Integer** |  | [optional] 
+**customers** | **Integer** |  | [optional] 
+**employees** | **Integer** |  | [optional] 
+
+

data/docs/Receipt.md

@@ -0,0 +1,28 @@
+# KoronaClient::Receipt
+
+## 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] 
+**account_transactions** | [**Array<AccountTransaction>**](AccountTransaction.md) |  | [optional] 
+**booking_time** | **DateTime** |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**creation_time** | **DateTime** |  | [optional] 
+**currency** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**customer** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**customer_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**customer_order** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**deposit_amount** | **Float** |  | [optional] 
+**geo_location** | [**GeoLocation**](GeoLocation.md) |  | [optional] 
+**items** | [**Array<ReceiptItem>**](ReceiptItem.md) |  | [optional] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**payments** | [**Array<Payment>**](Payment.md) |  | [optional] 
+**point_of_sale** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**price_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**voided** | **BOOLEAN** |  | [optional] 
+**zcounter** | **Integer** |  | [optional] 
+
+

data/docs/ReceiptItem.md

@@ -0,0 +1,16 @@
+# KoronaClient::ReceiptItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**booking_time** | **DateTime** |  | [optional] 
+**commodity_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**indent** | **Integer** |  | [optional] 
+**info_texts** | **Array<String>** |  | [optional] 
+**manual_price** | **BOOLEAN** |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**quantity** | **Float** |  | [optional] 
+**sector** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**total** | [**TotalPrice**](TotalPrice.md) |  | [optional] 
+
+

data/docs/ReceiptsApi.md

@@ -0,0 +1,139 @@
+# KoronaClient::ReceiptsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_receipt**](ReceiptsApi.md#get_receipt) | **GET** /accounts/{koronaAccountId}/receipts/receiptId} | lists a single receipt
+[**get_receipts**](ReceiptsApi.md#get_receipts) | **GET** /accounts/{koronaAccountId}/receipts | lists all receipts
+
+
+# **get_receipt**
+> Receipt get_receipt(korona_account_id, receipt_id)
+
+lists a single receipt
+
+
+
+### 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::ReceiptsApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+receipt_id = "receipt_id_example" # String | the id of the receipt
+
+
+begin
+  #lists a single receipt
+  result = api_instance.get_receipt(korona_account_id, receipt_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ReceiptsApi->get_receipt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **receipt_id** | **String**| the id of the receipt | 
+
+### Return type
+
+[**Receipt**](Receipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_receipts**
+> ResultListReceipt get_receipts(korona_account_id, opts)
+
+lists all receipts
+
+
+
+### 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::ReceiptsApi.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
+  point_of_sale: "point_of_sale_example", # String | point of sale
+  organizational_unit: "organizational_unit_example", # String | organizational unit
+  z_count: 789, # Integer | z-count of the receipt
+  min_create_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | min (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
+  max_create_time: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | max (inclusive) create time of the receipt (ISO 8601; date, time and timezone)
+}
+
+begin
+  #lists all receipts
+  result = api_instance.get_receipts(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling ReceiptsApi->get_receipts: #{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] 
+ **point_of_sale** | **String**| point of sale | [optional] 
+ **organizational_unit** | **String**| organizational unit | [optional] 
+ **z_count** | **Integer**| z-count of the receipt | [optional] 
+ **min_create_time** | **DateTime**| min (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+
+### Return type
+
+[**ResultListReceipt**](ResultListReceipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ResultList.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | **Array<Object>** | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListAccount.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Account>**](Account.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListAssortment.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListAssortment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Assortment>**](Assortment.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListCashier.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListCashier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Cashier>**](Cashier.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListCommodityGroup.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListCommodityGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<CommodityGroup>**](CommodityGroup.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListCurrency.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListCurrency
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Currency>**](Currency.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListCustomer.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListCustomer
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Customer>**](Customer.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListCustomerGroup.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListCustomerGroup
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<CustomerGroup>**](CustomerGroup.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListCustomerOrder.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListCustomerOrder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<CustomerOrder>**](CustomerOrder.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListDayRating.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListDayRating
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<DayRating>**](DayRating.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListEconomicZone.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListEconomicZone
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<EconomicZone>**](EconomicZone.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListEndOfDayStatement.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListEndOfDayStatement
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<EndOfDayStatement>**](EndOfDayStatement.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListEntryGate.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListEntryGate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<EntryGate>**](EntryGate.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListEvent.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListEvent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Event>**](Event.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListInfoText.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListInfoText
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<InfoText>**](InfoText.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListInventory.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListInventory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<Inventory>**](Inventory.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+

data/docs/ResultListInventoryList.md

@@ -0,0 +1,13 @@
+# KoronaClient::ResultListInventoryList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | number of the current page, starting from 1 | 
+**links** | **Hash<String, String>** | navigation links (previous, self, next) | 
+**pages_total** | **Integer** | pages count total | 
+**results** | [**Array<InventoryList>**](InventoryList.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+