korona-cloud-client 1.0.0

data/docs/CompanyIdentification.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::CompanyIdentification
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**gln** | **String** |  | [optional] 
+**tax_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CompanyIdentification.new(gln: null,
+                                 tax_id: null)
+```
+
+

data/docs/CreationTask.md

@@ -0,0 +1,37 @@
+# KoronaCloudClient::CreationTask
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entry_id** | **Integer** |  | [optional] 
+**description** | **String** |  | [optional] 
+**user** | **String** |  | [optional] 
+**creation_time** | **DateTime** |  | [optional] 
+**ticket_number_start** | **String** |  | [optional] 
+**quantity** | **Integer** |  | [optional] 
+**created** | **Integer** |  | [optional] 
+**status** | **String** |  | [optional] 
+**product_number** | **String** |  | [optional] 
+**personalization** | [**TicketPersonalization**](TicketPersonalization.md) |  | [optional] 
+**ticket_data** | [**TicketData**](TicketData.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CreationTask.new(entry_id: null,
+                                 description: null,
+                                 user: null,
+                                 creation_time: null,
+                                 ticket_number_start: null,
+                                 quantity: null,
+                                 created: null,
+                                 status: null,
+                                 product_number: null,
+                                 personalization: null,
+                                 ticket_data: null)
+```
+
+

data/docs/CurrenciesApi.md

@@ -0,0 +1,128 @@
+# KoronaCloudClient::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/{currencyId} | returns the single currency
+
+
+
+## get_currencies
+
+> ResultListCurrency get_currencies(korona_account_id, opts)
+
+lists all currencies
+
+### 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::CurrenciesApi.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 currencies
+  result = api_instance.get_currencies(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CurrenciesApi->get_currencies: #{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
+
+[**ResultListCurrency**](ResultListCurrency.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_currency
+
+> Currency get_currency(korona_account_id, currency_id)
+
+returns the single currency
+
+### 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::CurrenciesApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+currency_id = 'currency_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single currency
+  result = api_instance.get_currency(korona_account_id, currency_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CurrenciesApi->get_currency: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **currency_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**Currency**](Currency.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Currency.md

@@ -0,0 +1,39 @@
+# KoronaCloudClient::Currency
+
+## 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] 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Currency.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 cent_name: null,
+                                 decimal_places: null,
+                                 denominations: null,
+                                 exchange_rates: null,
+                                 key: null,
+                                 name: null,
+                                 system_currency: null,
+                                 symbol: null)
+```
+
+

data/docs/CurrencyDenomination.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::CurrencyDenomination
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CurrencyDenomination.new(type: null,
+                                 value: null)
+```
+
+

data/docs/CurrencyExchangeRate.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::CurrencyExchangeRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**factor** | **Float** |  | [optional] 
+**valid_from** | **DateTime** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CurrencyExchangeRate.new(factor: null,
+                                 valid_from: null)
+```
+
+

data/docs/Customer.md

@@ -0,0 +1,53 @@
+# KoronaCloudClient::Customer
+
+## 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] 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::Customer.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 address: null,
+                                 birthday: null,
+                                 cards: null,
+                                 company: null,
+                                 customer_group: null,
+                                 economic_zone: null,
+                                 email: null,
+                                 firstname: null,
+                                 gender: null,
+                                 informations: null,
+                                 lastname: null,
+                                 phone: null,
+                                 tax_id: null,
+                                 privacy_policy_accepted: null,
+                                 marketing_contact_permitted: null)
+```
+
+

data/docs/CustomerCard.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::CustomerCard
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CustomerCard.new(number: null,
+                                 type: null)
+```
+
+

data/docs/CustomerData.md

@@ -0,0 +1,19 @@
+# KoronaCloudClient::CustomerData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CustomerData.new(name: null,
+                                 phone: null)
+```
+
+

data/docs/CustomerGroup.md

@@ -0,0 +1,27 @@
+# KoronaCloudClient::CustomerGroup
+
+## 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] 
+**name** | **String** |  | [optional] 
+**price_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CustomerGroup.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 name: null,
+                                 price_group: null)
+```
+
+

data/docs/CustomerGroupSummary.md

@@ -0,0 +1,23 @@
+# KoronaCloudClient::CustomerGroupSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**customer_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**discount_amount** | **Float** |  | [optional] 
+**items** | **Float** |  | [optional] 
+**revenue** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CustomerGroupSummary.new(customer_group: null,
+                                 discount_amount: null,
+                                 items: null,
+                                 revenue: null)
+```
+
+

data/docs/CustomerGroupsApi.md

@@ -0,0 +1,128 @@
+# KoronaCloudClient::CustomerGroupsApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_customer_group**](CustomerGroupsApi.md#get_customer_group) | **GET** /accounts/{koronaAccountId}/customerGroups/{customerGroupId} | returns the single customer group
+[**get_customer_groups**](CustomerGroupsApi.md#get_customer_groups) | **GET** /accounts/{koronaAccountId}/customerGroups | lists all customer groups
+
+
+
+## get_customer_group
+
+> CustomerGroup get_customer_group(korona_account_id, customer_group_id)
+
+returns the single customer 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::CustomerGroupsApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_group_id = 'customer_group_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single customer group
+  result = api_instance.get_customer_group(korona_account_id, customer_group_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerGroupsApi->get_customer_group: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_group_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**CustomerGroup**](CustomerGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customer_groups
+
+> ResultListCustomerGroup get_customer_groups(korona_account_id, opts)
+
+lists all customer 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::CustomerGroupsApi.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 customer groups
+  result = api_instance.get_customer_groups(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerGroupsApi->get_customer_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
+
+[**ResultListCustomerGroup**](ResultListCustomerGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+