korona-cloud-client 1.0.0

data/docs/Rating.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::Rating
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**assortment** | **Integer** |  | [optional] 
+**customers** | **Integer** |  | [optional] 
+**employees** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Rating.new(assortment: null,
+                                 customers: null,
+                                 employees: null)
+```
+
+

data/docs/Receipt.md

@@ -0,0 +1,65 @@
+# KoronaCloudClient::Receipt
+
+## 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] 
+**account_transactions** | [**Array<AccountTransaction>**](AccountTransaction.md) |  | [optional] 
+**additional_info** | [**Array<AdditionalInfo>**](AdditionalInfo.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] 
+**order_number** | **String** |  | [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] 
+**signature** | [**Signature**](Signature.md) |  | [optional] 
+**cancelled** | **Boolean** |  | [optional] 
+**info_texts** | **Array<String>** |  | [optional] 
+**zcounter** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Receipt.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 account_transactions: null,
+                                 additional_info: null,
+                                 booking_time: null,
+                                 cashier: null,
+                                 creation_time: null,
+                                 currency: null,
+                                 customer: null,
+                                 customer_group: null,
+                                 order_number: null,
+                                 deposit_amount: null,
+                                 geo_location: null,
+                                 items: null,
+                                 organizational_unit: null,
+                                 payments: null,
+                                 point_of_sale: null,
+                                 price_group: null,
+                                 voided: null,
+                                 signature: null,
+                                 cancelled: null,
+                                 info_texts: null,
+                                 zcounter: null)
+```
+
+

data/docs/ReceiptItem.md

@@ -0,0 +1,41 @@
+# KoronaCloudClient::ReceiptItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**booking_time** | **DateTime** |  | [optional] 
+**commodity_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**indent** | **Integer** |  | [optional] 
+**info_texts** | **Array<String>** |  | [optional] 
+**discounts** | [**Array<Discount>**](Discount.md) |  | [optional] 
+**manual_price** | **Boolean** |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**quantity** | **Float** |  | [optional] 
+**recognition_number** | **String** |  | [optional] 
+**sector** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**serial_numbers** | **Array<String>** |  | [optional] 
+**total** | [**TotalPrice**](TotalPrice.md) |  | [optional] 
+**delivery_date** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ReceiptItem.new(booking_time: null,
+                                 commodity_group: null,
+                                 indent: null,
+                                 info_texts: null,
+                                 discounts: null,
+                                 manual_price: null,
+                                 product: null,
+                                 quantity: null,
+                                 recognition_number: null,
+                                 sector: null,
+                                 serial_numbers: null,
+                                 total: null,
+                                 delivery_date: null)
+```
+
+

data/docs/ReceiptsApi.md

@@ -0,0 +1,140 @@
+# KoronaCloudClient::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} | returns the 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)
+
+returns the single receipt
+
+### 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::ReceiptsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+receipt_id = 'receipt_id_example' # String | id of the receipt
+
+begin
+  #returns the single receipt
+  result = api_instance.get_receipt(korona_account_id, receipt_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling ReceiptsApi->get_receipt: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **receipt_id** | **String**| id of the receipt | 
+
+### Return type
+
+[**Receipt**](Receipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_receipts
+
+> ResultListReceipt get_receipts(korona_account_id, opts)
+
+lists all receipts
+
+### 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::ReceiptsApi.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
+  point_of_sale: 'point_of_sale_example', # String | point of sale
+  organizational_unit: 'organizational_unit_example', # String | organizational unit
+  z_count: 56, # 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; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_create_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  number: 'number_example', # String | number of the related object
+  min_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+}
+
+begin
+  #lists all receipts
+  result = api_instance.get_receipts(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling ReceiptsApi->get_receipts: #{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] 
+ **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; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+ **min_booking_time** | **DateTime**| min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_booking_time** | **DateTime**| max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+
+### Return type
+
+[**ResultListReceipt**](ResultListReceipt.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ResultList.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::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 | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultList.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/ResultListAccount.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::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 | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListAccount.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/ResultListAdditionalReceiptInfoType.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::ResultListAdditionalReceiptInfoType
+
+## 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<AdditionalReceiptInfoType>**](AdditionalReceiptInfoType.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListAdditionalReceiptInfoType.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/ResultListAssortment.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::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 | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListAssortment.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/ResultListAttendance.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::ResultListAttendance
+
+## 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<Attendance>**](Attendance.md) | result list | 
+**results_of_page** | **Integer** | result count of the current page | 
+**results_total** | **Integer** | result count total | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListAttendance.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/ResultListCashier.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::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 | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListCashier.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+

data/docs/ResultListCommodityGroup.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::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 | 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::ResultListCommodityGroup.new(current_page: null,
+                                 links: null,
+                                 pages_total: null,
+                                 results: null,
+                                 results_of_page: null,
+                                 results_total: null)
+```
+
+