korona-entry-client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1cdff6c51f5b814be6520b71d01e93b30bd0d864
+  data.tar.gz: bad162d4f6d23b2a78f2f235f58d99a8b57070fb
+SHA512:
+  metadata.gz: ed014b9b19f65a152827662084943b116e330be85a21fa85e6fb6ef750683c4d30f050bec613b23a807ce6576df8ba564f33cabe8ca9ed0171ea737881fec021
+  data.tar.gz: c29f81825087408306a238d34e8f02d920f6b554bdb9a6f655acc934dfa2fa016f47adbe59773f8f4b15f4ddcff5790c00767919b6207b50bee748f23455d0e5

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,128 @@
+# korona-entry-client
+
+KoronaEntryClient - the Ruby gem for the KORONA.entry API v1
+
+Our api provides access to our entry services
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build korona-entry-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./korona-entry-client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./korona-entry-client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'korona-entry-client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'korona-entry-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+client = 'client_example' # String | Identification of executing client.
+body = KoronaEntryClient::ExternalTicketConfiguration.new # ExternalTicketConfiguration | Properties to update of the external ticket configuration.
+
+begin
+  #Creates a new external ticket configuration. If an unkown ticket number will be checked and the pattern of the ticket number will be equals to a pattern of a external ticket configuration, a new ticket will be created. The TicketEntry of the external ticket configuration will be copied and adjusted to the new ticket. The newly created ticket is then checked for validity.
+  result = api_instance.create_external_ticket_configurations(client, body)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling ExternalTicketConfigurationsApi->create_external_ticket_configurations: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://YourLocalInstance.com/korona.entry_server/services/v1*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*KoronaEntryClient::ExternalTicketConfigurationsApi* | [**create_external_ticket_configurations**](docs/ExternalTicketConfigurationsApi.md#create_external_ticket_configurations) | **POST** /{client}/externalTicketConfigurations | Creates a new external ticket configuration. If an unkown ticket number will be checked and the pattern of the ticket number will be equals to a pattern of a external ticket configuration, a new ticket will be created. The TicketEntry of the external ticket configuration will be copied and adjusted to the new ticket. The newly created ticket is then checked for validity.
+*KoronaEntryClient::ExternalTicketConfigurationsApi* | [**delete_external_ticket_configuration**](docs/ExternalTicketConfigurationsApi.md#delete_external_ticket_configuration) | **DELETE** /{client}/externalTicketConfigurations/{externalTicketConfigurationId} | Deletes the single external ticket configuration.
+*KoronaEntryClient::ExternalTicketConfigurationsApi* | [**get_external_ticket_configuration**](docs/ExternalTicketConfigurationsApi.md#get_external_ticket_configuration) | **GET** /{client}/externalTicketConfigurations/{externalTicketConfigurationId} | Returns the external ticket configuration.
+*KoronaEntryClient::ExternalTicketConfigurationsApi* | [**get_external_ticket_configurations**](docs/ExternalTicketConfigurationsApi.md#get_external_ticket_configurations) | **GET** /{client}/externalTicketConfigurations | Returns all external ticket configurations
+*KoronaEntryClient::ExternalTicketConfigurationsApi* | [**update_external_ticket_configuration**](docs/ExternalTicketConfigurationsApi.md#update_external_ticket_configuration) | **PATCH** /{client}/externalTicketConfigurations/{externalTicketConfigurationId} | Updates the single external ticket configuration.
+*KoronaEntryClient::OrganizationalUnitsApi* | [**create_organizational_unit**](docs/OrganizationalUnitsApi.md#create_organizational_unit) | **POST** /{client}/organizationalUnits | Creates a new organizational unit.
+*KoronaEntryClient::OrganizationalUnitsApi* | [**delete_organizational_unit**](docs/OrganizationalUnitsApi.md#delete_organizational_unit) | **DELETE** /{client}/organizationalUnits/{organizationalUnitId} | Deletes the single organizational unit.
+*KoronaEntryClient::OrganizationalUnitsApi* | [**get_organizational_unit**](docs/OrganizationalUnitsApi.md#get_organizational_unit) | **GET** /{client}/organizationalUnits/{organizationalUnitId} | Returns the single organizational unit.
+*KoronaEntryClient::OrganizationalUnitsApi* | [**get_organizational_units**](docs/OrganizationalUnitsApi.md#get_organizational_units) | **GET** /{client}/organizationalUnits | Returns all organizational unit
+*KoronaEntryClient::OrganizationalUnitsApi* | [**update_organizational_unit**](docs/OrganizationalUnitsApi.md#update_organizational_unit) | **PATCH** /{client}/organizationalUnits/{organizationalUnitId} | Updates the single organizational unit.
+*KoronaEntryClient::TicketsApi* | [**check_ticket**](docs/TicketsApi.md#check_ticket) | **GET** /{client}/checkTicket | Checks a ticket. The entry can optionally also be committed.
+*KoronaEntryClient::TicketsApi* | [**create_ticket**](docs/TicketsApi.md#create_ticket) | **POST** /{client}/tickets | Creates a new ticket.
+*KoronaEntryClient::TicketsApi* | [**delete_image**](docs/TicketsApi.md#delete_image) | **DELETE** /{client}/tickets/{ticketId}/image | Deletes the owners image of the ticket.
+*KoronaEntryClient::TicketsApi* | [**delete_ticket**](docs/TicketsApi.md#delete_ticket) | **DELETE** /{client}/tickets/{ticketId} | Deletes the single ticket.
+*KoronaEntryClient::TicketsApi* | [**get_image**](docs/TicketsApi.md#get_image) | **GET** /{client}/tickets/{ticketId}/image | Returns the owners image of the ticket
+*KoronaEntryClient::TicketsApi* | [**get_logs**](docs/TicketsApi.md#get_logs) | **GET** /{client}/ticketEntryLogs | Returns the log for a optional single ticket and/or organizational unit
+*KoronaEntryClient::TicketsApi* | [**get_ticket**](docs/TicketsApi.md#get_ticket) | **GET** /{client}/tickets/{ticketId} | Returns the single ticket.
+*KoronaEntryClient::TicketsApi* | [**get_ticket_entry**](docs/TicketsApi.md#get_ticket_entry) | **GET** /{client}/tickets/{ticketId}/ticketEntries/{ticketEntryId} | Returns a single ticket entry.
+*KoronaEntryClient::TicketsApi* | [**get_tickets**](docs/TicketsApi.md#get_tickets) | **GET** /{client}/tickets | Lists all tickets.
+*KoronaEntryClient::TicketsApi* | [**update_image**](docs/TicketsApi.md#update_image) | **POST** /{client}/tickets/{ticketId}/image | Updates the owners image of the ticket
+*KoronaEntryClient::TicketsApi* | [**update_ticket**](docs/TicketsApi.md#update_ticket) | **PATCH** /{client}/tickets/{ticketId} | Updates the single ticket.
+
+
+## Documentation for Models
+
+ - [KoronaEntryClient::BadRequestError](docs/BadRequestError.md)
+ - [KoronaEntryClient::EntryResponse](docs/EntryResponse.md)
+ - [KoronaEntryClient::ExternalTicketConfiguration](docs/ExternalTicketConfiguration.md)
+ - [KoronaEntryClient::ExternalTicketConfigurationList](docs/ExternalTicketConfigurationList.md)
+ - [KoronaEntryClient::ModelReference](docs/ModelReference.md)
+ - [KoronaEntryClient::NotAcceptableError](docs/NotAcceptableError.md)
+ - [KoronaEntryClient::OrganizationalUnit](docs/OrganizationalUnit.md)
+ - [KoronaEntryClient::OrganizationalUnitList](docs/OrganizationalUnitList.md)
+ - [KoronaEntryClient::Ticket](docs/Ticket.md)
+ - [KoronaEntryClient::TicketEntry](docs/TicketEntry.md)
+ - [KoronaEntryClient::TicketEntryLog](docs/TicketEntryLog.md)
+ - [KoronaEntryClient::TicketEntryLogList](docs/TicketEntryLogList.md)
+ - [KoronaEntryClient::TicketImage](docs/TicketImage.md)
+ - [KoronaEntryClient::TicketInformation](docs/TicketInformation.md)
+ - [KoronaEntryClient::TicketList](docs/TicketList.md)
+ - [KoronaEntryClient::TicketPersonalization](docs/TicketPersonalization.md)
+
+
+## Documentation for Authorization
+
+
+### basicAuth
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/BadRequestError.md

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

data/docs/EntryResponse.md

@@ -0,0 +1,21 @@
+# KoronaEntryClient::EntryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**ticket** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**ticket_entry** | [**ModelReference**](ModelReference.md) |  | [optional] 
+**valid_to_max** | **DateTime** | maximum validity end date calculated. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::EntryResponse.new(ticket: null,
+                                 ticket_entry: null,
+                                 valid_to_max: null)
+```
+
+

data/docs/ExternalTicketConfiguration.md

@@ -0,0 +1,29 @@
+# KoronaEntryClient::ExternalTicketConfiguration
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Objects ID. | [optional] 
+**number** | **String** | Number of external ticket configuration. | [optional] 
+**name** | **String** | Name of external ticket configuration. | [optional] 
+**pattern** | **String** | Matching pattern for unkown external tickets. | [optional] 
+**valid_from_period** | **String** | Adjusts the validFrom value of TicketEntry while ticket creation dynamically to the ticket creation time plus the period. | [optional] 
+**valid_to_period** | **String** | Adjusts the validTo value of TicketEntry while ticket creation dynamically to the ticket creation time plus the period. | [optional] 
+**ticket_entries** | [**Array<TicketEntry>**](TicketEntry.md) | Validities for this configuration of external tickets. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'KoronaEntryClient'
+
+instance = KoronaEntryClient::ExternalTicketConfiguration.new(id: null,
+                                 number: null,
+                                 name: null,
+                                 pattern: null,
+                                 valid_from_period: null,
+                                 valid_to_period: null,
+                                 ticket_entries: null)
+```
+
+

data/docs/ExternalTicketConfigurationList.md

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

data/docs/ExternalTicketConfigurationsApi.md

@@ -0,0 +1,247 @@
+# KoronaEntryClient::ExternalTicketConfigurationsApi
+
+All URIs are relative to *https://YourLocalInstance.com/korona.entry_server/services/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_external_ticket_configurations**](ExternalTicketConfigurationsApi.md#create_external_ticket_configurations) | **POST** /{client}/externalTicketConfigurations | Creates a new external ticket configuration. If an unkown ticket number will be checked and the pattern of the ticket number will be equals to a pattern of a external ticket configuration, a new ticket will be created. The TicketEntry of the external ticket configuration will be copied and adjusted to the new ticket. The newly created ticket is then checked for validity.
+[**delete_external_ticket_configuration**](ExternalTicketConfigurationsApi.md#delete_external_ticket_configuration) | **DELETE** /{client}/externalTicketConfigurations/{externalTicketConfigurationId} | Deletes the single external ticket configuration.
+[**get_external_ticket_configuration**](ExternalTicketConfigurationsApi.md#get_external_ticket_configuration) | **GET** /{client}/externalTicketConfigurations/{externalTicketConfigurationId} | Returns the external ticket configuration.
+[**get_external_ticket_configurations**](ExternalTicketConfigurationsApi.md#get_external_ticket_configurations) | **GET** /{client}/externalTicketConfigurations | Returns all external ticket configurations
+[**update_external_ticket_configuration**](ExternalTicketConfigurationsApi.md#update_external_ticket_configuration) | **PATCH** /{client}/externalTicketConfigurations/{externalTicketConfigurationId} | Updates the single external ticket configuration.
+
+
+
+## create_external_ticket_configurations
+
+> ModelReference create_external_ticket_configurations(client, body)
+
+Creates a new external ticket configuration. If an unkown ticket number will be checked and the pattern of the ticket number will be equals to a pattern of a external ticket configuration, a new ticket will be created. The TicketEntry of the external ticket configuration will be copied and adjusted to the new ticket. The newly created ticket is then checked for validity.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+client = 'client_example' # String | Identification of executing client.
+body = KoronaEntryClient::ExternalTicketConfiguration.new # ExternalTicketConfiguration | Properties to update of the external ticket configuration.
+
+begin
+  #Creates a new external ticket configuration. If an unkown ticket number will be checked and the pattern of the ticket number will be equals to a pattern of a external ticket configuration, a new ticket will be created. The TicketEntry of the external ticket configuration will be copied and adjusted to the new ticket. The newly created ticket is then checked for validity.
+  result = api_instance.create_external_ticket_configurations(client, body)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling ExternalTicketConfigurationsApi->create_external_ticket_configurations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **body** | [**ExternalTicketConfiguration**](ExternalTicketConfiguration.md)| Properties to update of the external ticket configuration. | 
+
+### Return type
+
+[**ModelReference**](ModelReference.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_external_ticket_configuration
+
+> delete_external_ticket_configuration(client, external_ticket_configuration_id)
+
+Deletes the single external ticket configuration.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+client = 'client_example' # String | Identification of executing client.
+external_ticket_configuration_id = 56 # Integer | ID to identify the external ticket configuration.
+
+begin
+  #Deletes the single external ticket configuration.
+  api_instance.delete_external_ticket_configuration(client, external_ticket_configuration_id)
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling ExternalTicketConfigurationsApi->delete_external_ticket_configuration: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **external_ticket_configuration_id** | **Integer**| ID to identify the external ticket configuration. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_external_ticket_configuration
+
+> ExternalTicketConfiguration get_external_ticket_configuration(client, external_ticket_configuration_id)
+
+Returns the external ticket configuration.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+client = 'client_example' # String | Identification of executing client.
+external_ticket_configuration_id = 56 # Integer | ID to identify the external ticket configuration.
+
+begin
+  #Returns the external ticket configuration.
+  result = api_instance.get_external_ticket_configuration(client, external_ticket_configuration_id)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling ExternalTicketConfigurationsApi->get_external_ticket_configuration: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **external_ticket_configuration_id** | **Integer**| ID to identify the external ticket configuration. | 
+
+### Return type
+
+[**ExternalTicketConfiguration**](ExternalTicketConfiguration.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_external_ticket_configurations
+
+> ExternalTicketConfigurationList get_external_ticket_configurations(client)
+
+Returns all external ticket configurations
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+client = 'client_example' # String | Identification of executing client.
+
+begin
+  #Returns all external ticket configurations
+  result = api_instance.get_external_ticket_configurations(client)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling ExternalTicketConfigurationsApi->get_external_ticket_configurations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+
+### Return type
+
+[**ExternalTicketConfigurationList**](ExternalTicketConfigurationList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_external_ticket_configuration
+
+> ModelReference update_external_ticket_configuration(client, external_ticket_configuration_id, body)
+
+Updates the single external ticket configuration.
+
+### Example
+
+```ruby
+# load the gem
+require 'korona-entry-client'
+
+api_instance = KoronaEntryClient::ExternalTicketConfigurationsApi.new
+client = 'client_example' # String | Identification of executing client.
+external_ticket_configuration_id = 56 # Integer | ID to identify the external ticket configuration.
+body = KoronaEntryClient::ExternalTicketConfiguration.new # ExternalTicketConfiguration | Properties to update of the external ticket configuration.
+
+begin
+  #Updates the single external ticket configuration.
+  result = api_instance.update_external_ticket_configuration(client, external_ticket_configuration_id, body)
+  p result
+rescue KoronaEntryClient::ApiError => e
+  puts "Exception when calling ExternalTicketConfigurationsApi->update_external_ticket_configuration: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client** | **String**| Identification of executing client. | 
+ **external_ticket_configuration_id** | **Integer**| ID to identify the external ticket configuration. | 
+ **body** | [**ExternalTicketConfiguration**](ExternalTicketConfiguration.md)| Properties to update of the external ticket configuration. | 
+
+### Return type
+
+[**ModelReference**](ModelReference.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+