korona_client 1.0.0

data/docs/BadRequestError.md

@@ -0,0 +1,9 @@
+# KoronaClient::BadRequestError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | a short description of the error in english | [optional] 
+**code** | **String** | the code for client-side evaluation of the error | [optional] 
+
+

data/docs/Capacity.md

@@ -0,0 +1,9 @@
+# KoronaClient::Capacity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**available** | **Integer** |  | [optional] 
+**total** | **Integer** |  | [optional] 
+
+

data/docs/Cashier.md

@@ -0,0 +1,20 @@
+# KoronaClient::Cashier
+
+## 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] 
+**_alias** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+**firstname** | **String** |  | [optional] 
+**gender** | **String** |  | [optional] 
+**login_code** | **String** | contains the md5 hash of the cashiers login code | [optional] 
+**login_password** | **String** | contains the md5 hash of the cashiers login password | [optional] 
+**permissions** | **Array<String>** |  | [optional] 
+**role** | **String** |  | [optional] 
+**surname** | **String** |  | [optional] 
+
+

data/docs/CashierSummary.md

@@ -0,0 +1,13 @@
+# KoronaClient::CashierSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cancelled_items** | [**AmountCountData**](AmountCountData.md) |  | [optional] 
+**cancelled_receipts** | [**AmountCountData**](AmountCountData.md) |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**receipts** | [**AmountCountData**](AmountCountData.md) |  | [optional] 
+**returns** | [**AmountCountData**](AmountCountData.md) |  | [optional] 
+**voided_receipts** | [**AmountCountData**](AmountCountData.md) |  | [optional] 
+
+

data/docs/CashiersApi.md

@@ -0,0 +1,131 @@
+# KoronaClient::CashiersApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_cashier**](CashiersApi.md#get_cashier) | **GET** /accounts/{koronaAccountId}/cashiers/{cashierIdOrNumber} | lists the cashier
+[**get_cashiers**](CashiersApi.md#get_cashiers) | **GET** /accounts/{koronaAccountId}/cashiers | lists all cashiers
+
+
+# **get_cashier**
+> Cashier get_cashier(korona_account_id, cashier_id_or_number)
+
+lists the cashier
+
+
+
+### 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::CashiersApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+cashier_id_or_number = "cashier_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 cashier
+  result = api_instance.get_cashier(korona_account_id, cashier_id_or_number)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CashiersApi->get_cashier: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **cashier_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
+
+[**Cashier**](Cashier.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_cashiers**
+> ResultListCashier get_cashiers(korona_account_id, opts)
+
+lists all cashiers
+
+
+
+### 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::CashiersApi.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 cashiers
+  result = api_instance.get_cashiers(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CashiersApi->get_cashiers: #{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
+
+[**ResultListCashier**](ResultListCashier.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Category.md

@@ -0,0 +1,9 @@
+# KoronaClient::Category
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/CloudSubscription.md

@@ -0,0 +1,9 @@
+# KoronaClient::CloudSubscription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | [optional] 
+**valid_to** | **DateTime** |  | [optional] 
+
+

data/docs/CommodityGroup.md

@@ -0,0 +1,13 @@
+# KoronaClient::CommodityGroup
+
+## 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] 
+**name** | **String** |  | [optional] 
+**parent_commodity_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+

data/docs/CommodityGroupSummary.md

@@ -0,0 +1,11 @@
+# KoronaClient::CommodityGroupSummary
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commodity_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**discount_amount** | **Float** |  | [optional] 
+**items** | **Float** |  | [optional] 
+**revenue** | **Float** |  | [optional] 
+
+

data/docs/CompanyIdentification.md

@@ -0,0 +1,9 @@
+# KoronaClient::CompanyIdentification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gln** | **String** |  | [optional] 
+**tax_id** | **String** |  | [optional] 
+
+

data/docs/CurrenciesApi.md

@@ -0,0 +1,131 @@
+# KoronaClient::CurrenciesApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_currencies**](CurrenciesApi.md#get_currencies) | **GET** /accounts/{koronaAccountId}/currencies | lists all currencies
+[**get_currency**](CurrenciesApi.md#get_currency) | **GET** /accounts/{koronaAccountId}/currencies/{currencyIdOrNumber} | lists the currency
+
+
+# **get_currencies**
+> ResultListCurrency get_currencies(korona_account_id, opts)
+
+lists all currencies
+
+
+
+### 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::CurrenciesApi.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 currencies
+  result = api_instance.get_currencies(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CurrenciesApi->get_currencies: #{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
+
+[**ResultListCurrency**](ResultListCurrency.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_currency**
+> Currency get_currency(korona_account_id, currency_id_or_number)
+
+lists the currency
+
+
+
+### 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::CurrenciesApi.new
+
+korona_account_id = "korona_account_id_example" # String | the account id
+
+currency_id_or_number = "currency_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 currency
+  result = api_instance.get_currency(korona_account_id, currency_id_or_number)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling CurrenciesApi->get_currency: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| the account id | 
+ **currency_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
+
+[**Currency**](Currency.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Currency.md

@@ -0,0 +1,19 @@
+# KoronaClient::Currency
+
+## 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] 
+**cent_name** | **String** |  | [optional] 
+**decimal_places** | **Integer** |  | [optional] 
+**denominations** | [**Array<CurrencyDenomination>**](CurrencyDenomination.md) |  | [optional] 
+**exchange_rates** | [**Array<CurrencyExchangeRate>**](CurrencyExchangeRate.md) |  | [optional] 
+**key** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**system_currency** | **BOOLEAN** |  | [optional] 
+**symbol** | **String** |  | [optional] 
+
+

data/docs/CurrencyDenomination.md

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

data/docs/CurrencyExchangeRate.md

@@ -0,0 +1,9 @@
+# KoronaClient::CurrencyExchangeRate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**factor** | **Float** |  | [optional] 
+**valid_from** | **DateTime** |  | [optional] 
+
+

data/docs/Customer.md

@@ -0,0 +1,26 @@
+# KoronaClient::Customer
+
+## 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] 
+**address** | [**AddressInformation**](AddressInformation.md) |  | [optional] 
+**birthday** | **DateTime** |  | [optional] 
+**cards** | [**Array<CustomerCard>**](CustomerCard.md) |  | [optional] 
+**company** | **String** |  | [optional] 
+**customer_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**economic_zone** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+**firstname** | **String** |  | [optional] 
+**gender** | **String** |  | [optional] 
+**informations** | [**Array<CustomerInformation>**](CustomerInformation.md) |  | [optional] 
+**lastname** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+**tax_id** | **String** |  | [optional] 
+**privacy_policy_accepted** | **BOOLEAN** |  | [optional] 
+**marketing_contact_permitted** | **BOOLEAN** |  | [optional] 
+
+