korona-entry-client 1.0.0

data/docs/ModelReference.md

@@ -0,0 +1,23 @@
+# KoronaEntryClient::ModelReference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Global object ID. Recommanded to use for linking purposes. Will never change. | [optional] 
+**name** | **String** | Name of object, insofar as available. | [optional] 
+**number** | **String** | Number of object, insofar as available. | [optional] 
+**href** | **String** | Link to object. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::ModelReference.new(id: null,
+                                 name: null,
+                                 number: null,
+                                 href: null)
+```
+
+

data/docs/NotAcceptableError.md

@@ -0,0 +1,19 @@
+# KoronaEntryClient::NotAcceptableError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **String** | A short description of the error in english. | [optional] 
+**response** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::NotAcceptableError.new(message: null,
+                                 response: null)
+```
+
+

data/docs/OrganizationalUnit.md

@@ -0,0 +1,27 @@
+# KoronaEntryClient::OrganizationalUnit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Objects ID. | [optional] 
+**number** | **String** | Number of organizational unit. | [optional] 
+**name** | **String** | Name of organizational unit. | [optional] 
+**entry_gate** | **Boolean** | *True*, if this organizational unit is an entry gate. | [optional] 
+**has_children** | **Boolean** | *True*, if this organizational unit has children. | [optional] 
+**parent** | [**ModelReference**](ModelReference.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::OrganizationalUnit.new(id: null,
+                                 number: null,
+                                 name: null,
+                                 entry_gate: null,
+                                 has_children: null,
+                                 parent: null)
+```
+
+

data/docs/OrganizationalUnitList.md

@@ -0,0 +1,17 @@
+# KoronaEntryClient::OrganizationalUnitList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**organizational_units** | [**Array<OrganizationalUnit>**](OrganizationalUnit.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::OrganizationalUnitList.new(organizational_units: null)
+```
+
+

data/docs/OrganizationalUnitsApi.md

@@ -0,0 +1,247 @@
+# KoronaEntryClient::OrganizationalUnitsApi
+
+All URIs are relative to *https://YourLocalInstance.com/korona.entry_server/services/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_organizational_unit**](OrganizationalUnitsApi.md#create_organizational_unit) | **POST** /{client}/organizationalUnits | Creates a new organizational unit.
+[**delete_organizational_unit**](OrganizationalUnitsApi.md#delete_organizational_unit) | **DELETE** /{client}/organizationalUnits/{organizationalUnitId} | Deletes the single organizational unit.
+[**get_organizational_unit**](OrganizationalUnitsApi.md#get_organizational_unit) | **GET** /{client}/organizationalUnits/{organizationalUnitId} | Returns the single organizational unit.
+[**get_organizational_units**](OrganizationalUnitsApi.md#get_organizational_units) | **GET** /{client}/organizationalUnits | Returns all organizational unit
+[**update_organizational_unit**](OrganizationalUnitsApi.md#update_organizational_unit) | **PATCH** /{client}/organizationalUnits/{organizationalUnitId} | Updates the single organizational unit.
+
+
+
+## create_organizational_unit
+
+> ModelReference create_organizational_unit(client, body)
+
+Creates a new organizational unit.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::OrganizationalUnitsApi.new
+client = 'client_example' # String | Identification of executing client.
+body = KoronaEntryClient::OrganizationalUnit.new # OrganizationalUnit | Properties to update of the organizational unit.
+
+begin
+  #Creates a new organizational unit.
+  result = api_instance.create_organizational_unit(client, body)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->create_organizational_unit: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **body** | [**OrganizationalUnit**](OrganizationalUnit.md)| Properties to update of the organizational unit. | 
+
+### Return type
+
+[**ModelReference**](ModelReference.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_organizational_unit
+
+> delete_organizational_unit(client, organizational_unit_id)
+
+Deletes the single organizational unit.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::OrganizationalUnitsApi.new
+client = 'client_example' # String | Identification of executing client.
+organizational_unit_id = 56 # Integer | ID to identify the organizational unit.
+
+begin
+  #Deletes the single organizational unit.
+  api_instance.delete_organizational_unit(client, organizational_unit_id)
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->delete_organizational_unit: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **organizational_unit_id** | **Integer**| ID to identify the organizational unit. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_unit
+
+> OrganizationalUnit get_organizational_unit(client, organizational_unit_id)
+
+Returns the single organizational unit.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::OrganizationalUnitsApi.new
+client = 'client_example' # String | Identification of executing client.
+organizational_unit_id = 56 # Integer | ID to identify the organizational unit.
+
+begin
+  #Returns the single organizational unit.
+  result = api_instance.get_organizational_unit(client, organizational_unit_id)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_unit: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **organizational_unit_id** | **Integer**| ID to identify the organizational unit. | 
+
+### Return type
+
+[**OrganizationalUnit**](OrganizationalUnit.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_organizational_units
+
+> OrganizationalUnitList get_organizational_units(client)
+
+Returns all organizational unit
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::OrganizationalUnitsApi.new
+client = 'client_example' # String | Identification of executing client.
+
+begin
+  #Returns all organizational unit
+  result = api_instance.get_organizational_units(client)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->get_organizational_units: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+
+### Return type
+
+[**OrganizationalUnitList**](OrganizationalUnitList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_organizational_unit
+
+> ModelReference update_organizational_unit(client, organizational_unit_id, body)
+
+Updates the single organizational unit.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::OrganizationalUnitsApi.new
+client = 'client_example' # String | Identification of executing client.
+organizational_unit_id = 56 # Integer | ID to identify the organizational unit.
+body = KoronaEntryClient::OrganizationalUnit.new # OrganizationalUnit | Properties to update of the organizational unit.
+
+begin
+  #Updates the single organizational unit.
+  result = api_instance.update_organizational_unit(client, organizational_unit_id, body)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling OrganizationalUnitsApi->update_organizational_unit: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **organizational_unit_id** | **Integer**| ID to identify the organizational unit. | 
+ **body** | [**OrganizationalUnit**](OrganizationalUnit.md)| Properties to update of the organizational unit. | 
+
+### Return type
+
+[**ModelReference**](ModelReference.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Ticket.md

@@ -0,0 +1,35 @@
+# KoronaEntryClient::Ticket
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Objects ID. | [optional] 
+**number** | **String** | Tickets number. If null, number will be generated. | [optional] 
+**locked** | **Boolean** | *True*, if ticket is generally locked. | [optional] 
+**locked_to** | **DateTime** | Set, if ticket is temporarily locked until the specified date. Indiependent of *locked* property. | [optional] 
+**create_date** | **DateTime** | Date of creation. | [optional] [readonly] 
+**ticket_entries** | [**Array<TicketEntry>**](TicketEntry.md) | Validities for this ticket. | [optional] 
+**personalization** | [**TicketPersonalization**](TicketPersonalization.md) |  | [optional] 
+**active** | **Boolean** | Indicates whether the object is active for use or not. | [optional] [readonly] 
+**deactivation_date** | **DateTime** | Date of deactivation. | [optional] [readonly] 
+**external_ticket** | **Boolean** | Indicates whether the ticket is created by external ticket configuration. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::Ticket.new(id: null,
+                                 number: null,
+                                 locked: null,
+                                 locked_to: null,
+                                 create_date: null,
+                                 ticket_entries: null,
+                                 personalization: null,
+                                 active: null,
+                                 deactivation_date: null,
+                                 external_ticket: null)
+```
+
+

data/docs/TicketEntry.md

@@ -0,0 +1,49 @@
+# KoronaEntryClient::TicketEntry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Objects ID. | [optional] 
+**create_date** | **DateTime** | Date of creation. | [optional] [readonly] 
+**used_up** | **Boolean** | *True*, if the ticket is used up. | [optional] 
+**first_use** | **DateTime** | Date of first use. | [optional] [readonly] 
+**last_use** | **DateTime** | Date of last use (not exiting). | [optional] [readonly] 
+**last_exit** | **DateTime** | Date of last exiting. | [optional] [readonly] 
+**uses** | **Integer** | Number of entries already made. | [optional] [readonly] 
+**uses_max** | **Integer** | Optional maximum number of possible entries. | [optional] 
+**valid_from** | **DateTime** | When the ticket becomes valid. | [optional] 
+**valid_to** | **DateTime** | Optional fixed date until which the ticket is valid. | [optional] 
+**valid_from_time** | **String** | Time from which the ticket becomes valid within a day. Format: HH:ii:ss | [optional] 
+**valid_to_time** | **String** | Time until which the ticket becomes valid within a day. Format: HH:ii:ss | [optional] 
+**lock_after_use** | **Integer** | Specifies the number of days after which the ticket is locked from the first use. | [optional] 
+**entry_gates** | **Array<String>** | Number of access points to which this validity applies. | [optional] 
+**information** | [**TicketInformation**](TicketInformation.md) |  | [optional] 
+**locked_to** | **DateTime** | Date until which the ticketEntry is locked. | [optional] 
+**re_entry_lock** | **Integer** | Specifies how many seconds the ticket should be locked after a successful entry. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::TicketEntry.new(id: null,
+                                 create_date: null,
+                                 used_up: null,
+                                 first_use: null,
+                                 last_use: null,
+                                 last_exit: null,
+                                 uses: null,
+                                 uses_max: null,
+                                 valid_from: null,
+                                 valid_to: null,
+                                 valid_from_time: null,
+                                 valid_to_time: null,
+                                 lock_after_use: null,
+                                 entry_gates: null,
+                                 information: null,
+                                 locked_to: null,
+                                 re_entry_lock: null)
+```
+
+

data/docs/TicketEntryLog.md

@@ -0,0 +1,39 @@
+# KoronaEntryClient::TicketEntryLog
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Objects ID. | [optional] 
+**comment** | **String** | Short comment for this action. | [optional] 
+**ticket** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**ticket_entry** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**log_type** | **String** | Identification of action type. | [optional] 
+**response** | **String** | Identification of response type. | [optional] 
+**time** | **DateTime** | Time of action. | [optional] 
+**organizational_unit_number** | **String** | Number of the organizational unit concerned. | [optional] 
+**client** | **String** | Client concerned. | [optional] 
+**number_of_uses** | **Integer** | Number of uses if its an entry action. | [optional] 
+**commit_type** | **String** | Identification of commit type. | [optional] 
+**test_time** | **DateTime** | Time of testing. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::TicketEntryLog.new(id: null,
+                                 comment: null,
+                                 ticket: null,
+                                 ticket_entry: null,
+                                 log_type: null,
+                                 response: null,
+                                 time: null,
+                                 organizational_unit_number: null,
+                                 client: null,
+                                 number_of_uses: null,
+                                 commit_type: null,
+                                 test_time: null)
+```
+
+