korona_client 1.0.0 → 1.1.0

data/docs/DayTimePeriod.md

@@ -0,0 +1,9 @@
+# KoronaClient::DayTimePeriod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**from** | **String** |  | [optional] 
+**to** | **String** |  | [optional] 
+
+

data/docs/DeliveryNote.md

@@ -0,0 +1,22 @@
+# KoronaClient::DeliveryNote
+
+## 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] 
+**booking_time** | **DateTime** |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**comment** | **String** |  | [optional] 
+**customer** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**delivery_time** | **DateTime** |  | [optional] 
+**items** | [**Array<DeliveryNoteItem>**](DeliveryNoteItem.md) |  | [optional] 
+**order_number** | **String** |  | [optional] 
+**organizational_unit** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**point_of_sale** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**signature** | [**Signature**](Signature.md) |  | [optional] 
+**total** | [**TotalPrice**](TotalPrice.md) | calculated by accumulation of items total | [optional] 
+
+

data/docs/DeliveryNoteItem.md

@@ -0,0 +1,14 @@
+# KoronaClient::DeliveryNoteItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**product** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**quantity** | **Float** |  | [optional] 
+**serial_numbers** | **Array<String>** |  | [optional] 
+**sector** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**commodity_group** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**indent** | **Integer** |  | [optional] 
+**total** | [**TotalPrice**](TotalPrice.md) |  | [optional] 
+
+

data/docs/DeliveryNotesApi.md

@@ -0,0 +1,316 @@
+# KoronaClient::DeliveryNotesApi
+
+All URIs are relative to *https://www.koronacloud.com/web/api/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_delivery_notes**](DeliveryNotesApi.md#add_delivery_notes) | **POST** /accounts/{koronaAccountId}/deliveryNotes | adds delivery notes
+[**book_delivery_note**](DeliveryNotesApi.md#book_delivery_note) | **PATCH** /accounts/{koronaAccountId}/deliveryNotes/{deliveryNoteId}/book | book the single delivery note
+[**finalize_delivery_note**](DeliveryNotesApi.md#finalize_delivery_note) | **PATCH** /accounts/{koronaAccountId}/deliveryNotes/{deliveryNoteId}/finalize | finalize the single delivery note
+[**get_delivery_note**](DeliveryNotesApi.md#get_delivery_note) | **GET** /accounts/{koronaAccountId}/deliveryNotes/{deliveryNoteId} | returns a single delivery note
+[**get_delivery_notes**](DeliveryNotesApi.md#get_delivery_notes) | **GET** /accounts/{koronaAccountId}/deliveryNotes | lists all delivery notes
+
+
+# **add_delivery_notes**
+> Array<AddOrUpdateResult> add_delivery_notes(korona_account_id, body)
+
+adds delivery notes
+
+
+
+### 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::DeliveryNotesApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+body = [KoronaClient::DeliveryNote.new] # Array<DeliveryNote> | data to add
+
+
+begin
+  #adds delivery notes
+  result = api_instance.add_delivery_notes(korona_account_id, body)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling DeliveryNotesApi->add_delivery_notes: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **body** | [**Array&lt;DeliveryNote&gt;**](DeliveryNote.md)| data to add | 
+
+### Return type
+
+[**Array&lt;AddOrUpdateResult&gt;**](AddOrUpdateResult.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **book_delivery_note**
+> book_delivery_note(korona_account_id, delivery_note_id)
+
+book the single delivery note
+
+
+
+### 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::DeliveryNotesApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+delivery_note_id = 'delivery_note_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #book the single delivery note
+  api_instance.book_delivery_note(korona_account_id, delivery_note_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling DeliveryNotesApi->book_delivery_note: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **delivery_note_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**: application/json
+ - **Accept**: application/json
+
+
+
+# **finalize_delivery_note**
+> finalize_delivery_note(korona_account_id, delivery_note_id)
+
+finalize the single delivery note
+
+
+
+### 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::DeliveryNotesApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+delivery_note_id = 'delivery_note_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #finalize the single delivery note
+  api_instance.finalize_delivery_note(korona_account_id, delivery_note_id)
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling DeliveryNotesApi->finalize_delivery_note: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **delivery_note_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**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_delivery_note**
+> DeliveryNote get_delivery_note(korona_account_id, delivery_note_id)
+
+returns a single delivery note
+
+
+
+### 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::DeliveryNotesApi.new
+
+korona_account_id = 'korona_account_id_example' # String | account id of the KORONA.cloud account
+
+delivery_note_id = 'delivery_note_id_example' # String | id of the related object (important: id should match the uuid-format)
+
+
+begin
+  #returns a single delivery note
+  result = api_instance.get_delivery_note(korona_account_id, delivery_note_id)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling DeliveryNotesApi->get_delivery_note: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **korona_account_id** | **String**| account id of the KORONA.cloud account | 
+ **delivery_note_id** | **String**| id of the related object (important: id should match the uuid-format) | 
+
+### Return type
+
+[**DeliveryNote**](DeliveryNote.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_delivery_notes**
+> ResultListDeliveryNote get_delivery_notes(korona_account_id, opts)
+
+lists all delivery notes
+
+
+
+### 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::DeliveryNotesApi.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: 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_delivery_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone)
+  max_delivery_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone)
+  min_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
+  max_booking_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone)
+  point_of_sale: 'point_of_sale_example', # String | point of sale
+  organizational_unit: 'organizational_unit_example', # String | organizational unit
+  customer: 'customer_example', # String | customer id to filter by
+  number: 'number_example' # String | number of the related object
+}
+
+begin
+  #lists all delivery notes
+  result = api_instance.get_delivery_notes(korona_account_id, opts)
+  p result
+rescue KoronaClient::ApiError => e
+  puts "Exception when calling DeliveryNotesApi->get_delivery_notes: #{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_delivery_time** | **DateTime**| min (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **max_delivery_time** | **DateTime**| max (inclusive) delivery time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **min_booking_time** | **DateTime**| min (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **max_booking_time** | **DateTime**| max (inclusive) booking time of the receipt (ISO 8601; date, time and timezone) | [optional] 
+ **point_of_sale** | **String**| point of sale | [optional] 
+ **organizational_unit** | **String**| organizational unit | [optional] 
+ **customer** | **String**| customer id to filter by | [optional] 
+ **number** | **String**| number of the related object | [optional] 
+
+### Return type
+
+[**ResultListDeliveryNote**](ResultListDeliveryNote.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Deposit.md

@@ -0,0 +1,12 @@
+# KoronaClient::Deposit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**amount** | **Float** |  | [optional] 
+**receipt_number** | **String** |  | [optional] 
+**cashier** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**create_time** | **DateTime** |  | [optional] 
+
+

data/docs/Discount.md

@@ -0,0 +1,10 @@
+# KoronaClient::Discount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Float** |  | [optional] 
+**label** | **String** |  | [optional] 
+**receipt_discount** | **BOOLEAN** |  | [optional] 
+
+

data/docs/EconomicZonesApi.md

@@ -4,14 +4,14 @@ All URIs are relative to *https://www.koronacloud.com/web/api/v3*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**get_economic_zone**](EconomicZonesApi.md#get_economic_zone) | **GET** /accounts/{koronaAccountId}/economicZones/{economicZoneIdOrNumber} | lists the economic zone
+[**get_economic_zone**](EconomicZonesApi.md#get_economic_zone) | **GET** /accounts/{koronaAccountId}/economicZones/{economicZoneId} | returns the single economic zone
 [**get_economic_zones**](EconomicZonesApi.md#get_economic_zones) | **GET** /accounts/{koronaAccountId}/economicZones | lists all economic zones
 
 
 # **get_economic_zone**
-> EconomicZone get_economic_zone(korona_account_id, economic_zone_id_or_number)
+> EconomicZone get_economic_zone(korona_account_id, economic_zone_id)
 
-lists the economic zone
+returns the single economic zone
 
 
 
@@ -28,14 +28,14 @@ end
 
 api_instance = KoronaClient::EconomicZonesApi.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
 
-economic_zone_id_or_number = "economic_zone_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)
+economic_zone_id = 'economic_zone_id_example' # String | id of the related object (important: id should match the uuid-format)
 
 
 begin
-  #lists the economic zone
-  result = api_instance.get_economic_zone(korona_account_id, economic_zone_id_or_number)
+  #returns the single economic zone
+  result = api_instance.get_economic_zone(korona_account_id, economic_zone_id)
   p result
 rescue KoronaClient::ApiError => e
   puts "Exception when calling EconomicZonesApi->get_economic_zone: #{e}"
@@ -46,8 +46,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **korona_account_id** | **String**| the account id | 
- **economic_zone_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 | 
+ **economic_zone_id** | **String**| id of the related object (important: id should match the uuid-format) | 
 
 ### Return type
 
@@ -84,14 +84,15 @@ end
 
 api_instance = KoronaClient::EconomicZonesApi.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