korona-cloud-client 1.0.0

data/docs/CustomerInformation.md

@@ -0,0 +1,21 @@
+# KoronaCloudClient::CustomerInformation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**creator_name** | **String** |  | [optional] 
+**date** | **DateTime** |  | [optional] 
+**text** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CustomerInformation.new(creator_name: null,
+                                 date: null,
+                                 text: null)
+```
+
+

data/docs/CustomerOrder.md

@@ -0,0 +1,53 @@
+# KoronaCloudClient::CustomerOrder
+
+## 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] 
+**booking_time** | **DateTime** |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**comment** | **String** |  | [optional] 
+**create_time** | **DateTime** |  | [optional] 
+**customer** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**customer_data** | [**CustomerData**](CustomerData.md) |  | [optional] 
+**deposits** | [**Array<Deposit>**](Deposit.md) |  | [optional] 
+**finish_time** | **DateTime** |  | [optional] 
+**info_texts** | **Array<String>** |  | [optional] 
+**items** | [**Array<ReceiptItem>**](ReceiptItem.md) |  | [optional] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**pick_up_time** | **DateTime** |  | [optional] 
+**point_of_sale** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**ready_for_pick_up** | **Boolean** |  | [optional] 
+**warehouse** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaCloudClient'
+
+instance = KoronaCloudClient::CustomerOrder.new(active: null,
+                                 id: null,
+                                 number: null,
+                                 revision: null,
+                                 booking_time: null,
+                                 cashier: null,
+                                 comment: null,
+                                 create_time: null,
+                                 customer: null,
+                                 customer_data: null,
+                                 deposits: null,
+                                 finish_time: null,
+                                 info_texts: null,
+                                 items: null,
+                                 organizational_unit: null,
+                                 pick_up_time: null,
+                                 point_of_sale: null,
+                                 ready_for_pick_up: null,
+                                 warehouse: null)
+```
+
+

data/docs/CustomerOrdersApi.md

@@ -0,0 +1,358 @@
+# KoronaCloudClient::CustomerOrdersApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_customer_orders**](CustomerOrdersApi.md#add_customer_orders) | **POST** /accounts/{koronaAccountId}/customerOrders | adds a batch of new customer orders
+[**delete_customer_order**](CustomerOrdersApi.md#delete_customer_order) | **DELETE** /accounts/{koronaAccountId}/customerOrders/{customerOrderId} | deletes the single customer order
+[**get_customer_order**](CustomerOrdersApi.md#get_customer_order) | **GET** /accounts/{koronaAccountId}/customerOrders/{customerOrderId} | returns the single customer order
+[**get_customer_orders**](CustomerOrdersApi.md#get_customer_orders) | **GET** /accounts/{koronaAccountId}/customerOrders | lists all customer orders
+[**update_customer_order**](CustomerOrdersApi.md#update_customer_order) | **PATCH** /accounts/{koronaAccountId}/customerOrders/{customerOrderId} | updates the single customer order
+[**update_customer_orders**](CustomerOrdersApi.md#update_customer_orders) | **PATCH** /accounts/{koronaAccountId}/customerOrders | updates a batch of customer orders
+
+
+
+## add_customer_orders
+
+> Array<AddOrUpdateResult> add_customer_orders(korona_account_id, body)
+
+adds a batch of new customer orders
+
+### 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::CustomerOrdersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::CustomerOrder.new] # Array<CustomerOrder> | array of new customer orders
+
+begin
+  #adds a batch of new customer orders
+  result = api_instance.add_customer_orders(korona_account_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerOrdersApi->add_customer_orders: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;CustomerOrder&gt;**](CustomerOrder.md)| array of new customer orders | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_customer_order
+
+> delete_customer_order(korona_account_id, customer_order_id, opts)
+
+deletes the single customer order
+
+### 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::CustomerOrdersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_order_id = 'customer_order_id_example' # String | id of the related object (important: id should match the uuid-format)
+opts = {
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #deletes the single customer order
+  api_instance.delete_customer_order(korona_account_id, customer_order_id, opts)
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerOrdersApi->delete_customer_order: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_order_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customer_order
+
+> CustomerOrder get_customer_order(korona_account_id, customer_order_id)
+
+returns the single customer order
+
+### 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::CustomerOrdersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_order_id = 'customer_order_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single customer order
+  result = api_instance.get_customer_order(korona_account_id, customer_order_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerOrdersApi->get_customer_order: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_order_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**CustomerOrder**](CustomerOrder.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customer_orders
+
+> ResultListCustomerOrder get_customer_orders(korona_account_id, opts)
+
+lists all customer orders
+
+### 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::CustomerOrdersApi.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)
+  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)
+  min_pick_up_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) pick up time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  max_pick_up_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) pick up time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all customer orders
+  result = api_instance.get_customer_orders(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerOrdersApi->get_customer_orders: #{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] 
+ **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] 
+ **min_pick_up_time** | **DateTime**| min (inclusive) pick up time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **max_pick_up_time** | **DateTime**| max (inclusive) pick up time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+[**ResultListCustomerOrder**](ResultListCustomerOrder.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_customer_order
+
+> update_customer_order(korona_account_id, customer_order_id, body)
+
+updates the single customer order
+
+### 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::CustomerOrdersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_order_id = 'customer_order_id_example' # String | id of the related object (important: id should match the uuid-format)
+body = KoronaCloudClient::CustomerOrder.new # CustomerOrder | the properties to update of the customer order
+
+begin
+  #updates the single customer order
+  api_instance.update_customer_order(korona_account_id, customer_order_id, body)
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerOrdersApi->update_customer_order: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_order_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**CustomerOrder**](CustomerOrder.md)| the properties to update of the customer order | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_customer_orders
+
+> Array&lt;AddOrUpdateResult&gt; update_customer_orders(korona_account_id, body)
+
+updates a batch of customer orders
+
+[number] must be set in the objects, otherwise the object cannot be updated
+
+### 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::CustomerOrdersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::CustomerOrder.new] # Array<CustomerOrder> | an array of existing customer orders
+
+begin
+  #updates a batch of customer orders
+  result = api_instance.update_customer_orders(korona_account_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomerOrdersApi->update_customer_orders: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;CustomerOrder&gt;**](CustomerOrder.md)| an array of existing customer orders | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CustomersApi.md

@@ -0,0 +1,402 @@
+# KoronaCloudClient::CustomersApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_customers**](CustomersApi.md#add_customers) | **POST** /accounts/{koronaAccountId}/customers | adds a batch of new customers
+[**delete_customer**](CustomersApi.md#delete_customer) | **DELETE** /accounts/{koronaAccountId}/customers/{customerId} | deletes the single customer
+[**delete_customers**](CustomersApi.md#delete_customers) | **DELETE** /accounts/{koronaAccountId}/customers | deletes a batch of customers
+[**get_customer**](CustomersApi.md#get_customer) | **GET** /accounts/{koronaAccountId}/customers/{customerId} | returns the single customer
+[**get_customers**](CustomersApi.md#get_customers) | **GET** /accounts/{koronaAccountId}/customers | lists all customers
+[**update_customer**](CustomersApi.md#update_customer) | **PATCH** /accounts/{koronaAccountId}/customers/{customerId} | updates the single customer
+[**update_customers**](CustomersApi.md#update_customers) | **PATCH** /accounts/{koronaAccountId}/customers | updates a batch of customers
+
+
+
+## add_customers
+
+> Array<AddOrUpdateResult> add_customers(korona_account_id, body, opts)
+
+adds a batch of new customers
+
+### 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::CustomersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::Customer.new] # Array<Customer> | array of new customers
+opts = {
+  upsert: true # Boolean | when set to true, updates the object instead of generating a already-exists-error
+}
+
+begin
+  #adds a batch of new customers
+  result = api_instance.add_customers(korona_account_id, body, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->add_customers: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Customer&gt;**](Customer.md)| array of new customers | 
+ **upsert** | **Boolean**| when set to true, updates the object instead of generating a already-exists-error | [optional] 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_customer
+
+> delete_customer(korona_account_id, customer_id)
+
+deletes the single customer
+
+### 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::CustomersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_id = 'customer_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #deletes the single customer
+  api_instance.delete_customer(korona_account_id, customer_id)
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->delete_customer: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_customers
+
+> Array&lt;AddOrUpdateResult&gt; delete_customers(korona_account_id, body)
+
+deletes a batch of customers
+
+### 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::CustomersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::Customer.new] # Array<Customer> | array of existing customers (id or number required)
+
+begin
+  #deletes a batch of customers
+  result = api_instance.delete_customers(korona_account_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->delete_customers: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Customer&gt;**](Customer.md)| array of existing customers (id or number required) | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_customer
+
+> Customer get_customer(korona_account_id, customer_id)
+
+returns the single customer
+
+### 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::CustomersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_id = 'customer_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+begin
+  #returns the single customer
+  result = api_instance.get_customer(korona_account_id, customer_id)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->get_customer: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**Customer**](Customer.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_customers
+
+> ResultListCustomer get_customers(korona_account_id, opts)
+
+lists all customers
+
+### 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::CustomersApi.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 customers
+  result = api_instance.get_customers(korona_account_id, opts)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->get_customers: #{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
+
+[**ResultListCustomer**](ResultListCustomer.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_customer
+
+> update_customer(korona_account_id, customer_id, body)
+
+updates the single customer
+
+### 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::CustomersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+customer_id = 'customer_id_example' # String | id of the related object (important: id should match the uuid-format)
+body = KoronaCloudClient::Customer.new # Customer | the properties to update of the customer
+
+begin
+  #updates the single customer
+  api_instance.update_customer(korona_account_id, customer_id, body)
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->update_customer: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **customer_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+ **body** | [**Customer**](Customer.md)| the properties to update of the customer | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_customers
+
+> Array&lt;AddOrUpdateResult&gt; update_customers(korona_account_id, body)
+
+updates a batch of customers
+
+### 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::CustomersApi.new
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+body = [KoronaCloudClient::Customer.new] # Array<Customer> | array of existing customers (id or number required)
+
+begin
+  #updates a batch of customers
+  result = api_instance.update_customers(korona_account_id, body)
+  p result
+rescue KoronaCloudClient::ApiError => e
+  puts "Exception when calling CustomersApi->update_customers: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;Customer&gt;**](Customer.md)| array of existing customers (id or number required) | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+