korona_client 1.0.0 → 1.1.0

data/docs/CreationTask.md

@@ -0,0 +1,17 @@
+# KoronaClient::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] 
+**article_number** | **String** |  | [optional] 
+**personalization** | [**TicketPersonalization**](TicketPersonalization.md) |  | [optional] 
+
+

data/docs/CurrenciesApi.md

@@ -5,7 +5,7 @@ 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_currency**](CurrenciesApi.md#get_currency) | **GET** /accounts/{koronaAccountId}/currencies/{currencyId} | returns the single currency
 
 
 # **get_currencies**
@@ -28,14 +28,15 @@ end
 
 api_instance = KoronaClient::CurrenciesApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+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)
+  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)
+  include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
 }
 
 begin
@@ -51,12 +52,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
+ **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
 
@@ -74,9 +76,9 @@ Name | Type | Description  | Notes
 
 
 # **get_currency**
-> Currency get_currency(korona_account_id, currency_id_or_number)
+> Currency get_currency(korona_account_id, currency_id)
 
-lists the currency
+returns the single currency
 
 
 
@@ -93,14 +95,14 @@ end
 
 api_instance = KoronaClient::CurrenciesApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-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)
+currency_id = 'currency_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the currency
-  result = api_instance.get_currency(korona_account_id, currency_id_or_number)
+  #returns the single currency
+  result = api_instance.get_currency(korona_account_id, currency_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CurrenciesApi->get_currency: #{e}"
@@ -111,8 +113,8 @@ end
 
 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) | 
+ **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
 

data/docs/CustomerGroupsApi.md

@@ -4,14 +4,14 @@ 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/{customerGroupIdOrNumber} | lists the customer group
+[**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_or_number)
+> CustomerGroup get_customer_group(korona_account_id, customer_group_id)
 
-lists the customer group
+returns the single customer group
 
 
 
@@ -28,14 +28,14 @@ end
 
 api_instance = KoronaClient::CustomerGroupsApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_group_id_or_number = "customer_group_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)
+customer_group_id = 'customer_group_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the customer group
-  result = api_instance.get_customer_group(korona_account_id, customer_group_id_or_number)
+  #returns the single customer group
+  result = api_instance.get_customer_group(korona_account_id, customer_group_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomerGroupsApi->get_customer_group: #{e}"
@@ -46,8 +46,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_group_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) | 
+ **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
 
@@ -84,14 +84,15 @@ end
 
 api_instance = KoronaClient::CustomerGroupsApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+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)
+  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)
+  include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
 }
 
 begin
@@ -107,12 +108,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
+ **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
 

data/docs/CustomerOrder.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 **create_time** | **DateTime** |  | [optional] 
 **customer** | [**ModelReference**](ModelReference.md) |  | [optional] 
 **customer_data** | [**CustomerData**](CustomerData.md) |  | [optional] 
-**deposit** | **Float** |  | [optional] 
-**deposit_account** | [**ModelReference**](ModelReference.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] 

data/docs/CustomerOrdersApi.md

@@ -5,11 +5,11 @@ 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/{customerOrderIdOrNumber} | deletes the customer order
-[**get_customer_order**](CustomerOrdersApi.md#get_customer_order) | **GET** /accounts/{koronaAccountId}/customerOrders/{customerOrderIdOrNumber} | lists the customer order
+[**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/{customerOrderIdOrNumber} | changes the customer order
-[**update_customer_orders**](CustomerOrdersApi.md#update_customer_orders) | **PATCH** /accounts/{koronaAccountId}/customerOrders | changes a batch of 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**
@@ -32,9 +32,9 @@ end
 
 api_instance = KoronaClient::CustomerOrdersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-body = [KoronaClient::CustomerOrder.new] # Array<CustomerOrder> | a array of new customer orders
+body = [KoronaClient::CustomerOrder.new] # Array<CustomerOrder> | array of new customer orders
 
 
 begin
@@ -50,8 +50,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **body** | [**Array&lt;CustomerOrder&gt;**](CustomerOrder.md)| a array of new customer orders | 
+ **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
 
@@ -69,9 +69,9 @@ Name | Type | Description  | Notes
 
 
 # **delete_customer_order**
-> delete_customer_order(korona_account_id, customer_order_id_or_number)
+> delete_customer_order(korona_account_id, customer_order_id, opts)
 
-deletes the customer order
+deletes the single customer order
 
 
 
@@ -88,14 +88,17 @@ end
 
 api_instance = KoronaClient::CustomerOrdersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_order_id_or_number = "customer_order_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)
+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 customer order
-  api_instance.delete_customer_order(korona_account_id, customer_order_id_or_number)
+  #deletes the single customer order
+  api_instance.delete_customer_order(korona_account_id, customer_order_id, opts)
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomerOrdersApi->delete_customer_order: #{e}"
 end
@@ -105,8 +108,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_order_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) | 
+ **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
 
@@ -124,9 +128,9 @@ nil (empty response body)
 
 
 # **get_customer_order**
-> CustomerOrder get_customer_order(korona_account_id, customer_order_id_or_number)
+> CustomerOrder get_customer_order(korona_account_id, customer_order_id)
 
-lists the customer order
+returns the single customer order
 
 
 
@@ -143,14 +147,14 @@ end
 
 api_instance = KoronaClient::CustomerOrdersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_order_id_or_number = "customer_order_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)
+customer_order_id = 'customer_order_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the customer order
-  result = api_instance.get_customer_order(korona_account_id, customer_order_id_or_number)
+  #returns the single customer order
+  result = api_instance.get_customer_order(korona_account_id, customer_order_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomerOrdersApi->get_customer_order: #{e}"
@@ -161,8 +165,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_order_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) | 
+ **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
 
@@ -199,18 +203,19 @@ end
 
 api_instance = KoronaClient::CustomerOrdersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+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)
+  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)
-  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)
-  min_pick_up_time: DateTime.parse("2013-10-20T19:20:30+01:00"), # DateTime | min (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone)
-  max_pick_up_time: DateTime.parse("2013-10-20T19:20:30+01:00") # DateTime | max (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone)
+  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)
+  min_pick_up_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone)
+  max_pick_up_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone)
+  number: 'number_example' # String | number of the related object
 }
 
 begin
@@ -226,7 +231,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
+ **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] 
@@ -236,6 +241,7 @@ Name | Type | Description  | Notes
  **max_create_time** | **DateTime**| max (inclusive) create time of the receipt (ISO 8601; date, time and timezone) | [optional] 
  **min_pick_up_time** | **DateTime**| min (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone) | [optional] 
  **max_pick_up_time** | **DateTime**| max (inclusive) pick up time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **number** | **String**| number of the related object | [optional] 
 
 ### Return type
 
@@ -253,11 +259,11 @@ Name | Type | Description  | Notes
 
 
 # **update_customer_order**
-> update_customer_order(korona_account_id, customer_order_id_or_number, body)
+> update_customer_order(korona_account_id, customer_order_id, body)
+
+updates the single customer order
 
-changes the customer order
 
-if [number] is set, the number of the object will change and the resource location as well
 
 ### Example
 ```ruby
@@ -272,16 +278,16 @@ end
 
 api_instance = KoronaClient::CustomerOrdersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_order_id_or_number = "customer_order_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)
+customer_order_id = 'customer_order_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 body = KoronaClient::CustomerOrder.new # CustomerOrder | the properties to update of the customer order
 
 
 begin
-  #changes the customer order
-  api_instance.update_customer_order(korona_account_id, customer_order_id_or_number, body)
+  #updates the single customer order
+  api_instance.update_customer_order(korona_account_id, customer_order_id, body)
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomerOrdersApi->update_customer_order: #{e}"
 end
@@ -291,8 +297,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_order_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) | 
+ **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
@@ -313,7 +319,7 @@ nil (empty response body)
 # **update_customer_orders**
 > Array&lt;AddOrUpdateResult&gt; update_customer_orders(korona_account_id, body)
 
-changes a batch of customer orders
+updates a batch of customer orders
 
 [number] must be set in the objects, otherwise the object cannot be updated
 
@@ -330,13 +336,13 @@ end
 
 api_instance = KoronaClient::CustomerOrdersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-body = [KoronaClient::CustomerOrder.new] # Array<CustomerOrder> | a array of existing customer orders
+body = [KoronaClient::CustomerOrder.new] # Array<CustomerOrder> | an array of existing customer orders
 
 
 begin
-  #changes a batch of customer orders
+  #updates a batch of customer orders
   result = api_instance.update_customer_orders(korona_account_id, body)
   p result
 rescue KoronaClient::ApiError => e
@@ -348,8 +354,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **body** | [**Array&lt;CustomerOrder&gt;**](CustomerOrder.md)| a array of existing customer orders | 
+ **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
 

data/docs/CustomersApi.md

@@ -5,15 +5,16 @@ 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/{customerIdOrNumber} | deletes the customer
-[**get_customer**](CustomersApi.md#get_customer) | **GET** /accounts/{koronaAccountId}/customers/{customerIdOrNumber} | lists the customer
+[**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/{customerIdOrNumber} | updates the customer
-[**update_customers**](CustomersApi.md#update_customers) | **PATCH** /accounts/{koronaAccountId}/customers | changes a batch of 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)
+> Array<AddOrUpdateResult> add_customers(korona_account_id, body, opts)
 
 adds a batch of new customers
 
@@ -32,14 +33,17 @@ end
 
 api_instance = KoronaClient::CustomersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-body = [KoronaClient::Customer.new] # Array<Customer> | a array of new customers
+body = [KoronaClient::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)
+  result = api_instance.add_customers(korona_account_id, body, opts)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomersApi->add_customers: #{e}"
@@ -50,8 +54,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **body** | [**Array&lt;Customer&gt;**](Customer.md)| a array of new customers | 
+ **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
 
@@ -69,9 +74,9 @@ Name | Type | Description  | Notes
 
 
 # **delete_customer**
-> delete_customer(korona_account_id, customer_id_or_number)
+> delete_customer(korona_account_id, customer_id)
 
-deletes the customer
+deletes the single customer
 
 
 
@@ -88,14 +93,14 @@ end
 
 api_instance = KoronaClient::CustomersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_id_or_number = "customer_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)
+customer_id = 'customer_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #deletes the customer
-  api_instance.delete_customer(korona_account_id, customer_id_or_number)
+  #deletes the single customer
+  api_instance.delete_customer(korona_account_id, customer_id)
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomersApi->delete_customer: #{e}"
 end
@@ -105,8 +110,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_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) | 
+ **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
 
@@ -123,10 +128,66 @@ nil (empty response body)
 
 
 
+# **delete_customers**
+> Array&lt;AddOrUpdateResult&gt; delete_customers(korona_account_id, body)
+
+deletes a batch of customers
+
+
+
+### 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::CustomersApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::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 KoronaClient::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_or_number)
+> Customer get_customer(korona_account_id, customer_id)
 
-lists the customer
+returns the single customer
 
 
 
@@ -143,14 +204,14 @@ end
 
 api_instance = KoronaClient::CustomersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_id_or_number = "customer_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)
+customer_id = 'customer_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the customer
-  result = api_instance.get_customer(korona_account_id, customer_id_or_number)
+  #returns the single customer
+  result = api_instance.get_customer(korona_account_id, customer_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomersApi->get_customer: #{e}"
@@ -161,8 +222,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_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) | 
+ **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
 
@@ -199,14 +260,15 @@ end
 
 api_instance = KoronaClient::CustomersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+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)
+  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)
+  include_deleted: true, # BOOLEAN | indicates deleted objects should be loaded or not (default: false)
+  number: 'number_example' # String | number of the related object
 }
 
 begin
@@ -222,12 +284,13 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
+ **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
 
@@ -245,9 +308,9 @@ Name | Type | Description  | Notes
 
 
 # **update_customer**
-> update_customer(korona_account_id, customer_id_or_number, body)
+> update_customer(korona_account_id, customer_id, body)
 
-updates the customer
+updates the single customer
 
 
 
@@ -264,16 +327,16 @@ end
 
 api_instance = KoronaClient::CustomersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-customer_id_or_number = "customer_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)
+customer_id = 'customer_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 body = KoronaClient::Customer.new # Customer | the properties to update of the customer
 
 
 begin
-  #updates the customer
-  api_instance.update_customer(korona_account_id, customer_id_or_number, body)
+  #updates the single customer
+  api_instance.update_customer(korona_account_id, customer_id, body)
 rescue KoronaClient::ApiError => e
   puts "Exception when calling CustomersApi->update_customer: #{e}"
 end
@@ -283,8 +346,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **customer_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) | 
+ **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
@@ -305,9 +368,9 @@ nil (empty response body)
 # **update_customers**
 > Array&lt;AddOrUpdateResult&gt; update_customers(korona_account_id, body)
 
-changes a batch of customers
+updates a batch of customers
+
 
-[number] must be set in the objects, otherwise the object cannot be updated
 
 ### Example
 ```ruby
@@ -322,13 +385,13 @@ end
 
 api_instance = KoronaClient::CustomersApi.new
 
-korona_account_id = "korona_account_id_example" # String | the account id
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
 
-body = [KoronaClient::Customer.new] # Array<Customer> | a array of existing customers
+body = [KoronaClient::Customer.new] # Array<Customer> | array of existing customers (id or number required)
 
 
 begin
-  #changes a batch of customers
+  #updates a batch of customers
   result = api_instance.update_customers(korona_account_id, body)
   p result
 rescue KoronaClient::ApiError => e
@@ -340,8 +403,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **body** | [**Array&lt;Customer&gt;**](Customer.md)| a array of existing customers | 
+ **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