korona-entry-client 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +10 -5
- data/docs/ExternalTicketConfigurationsApi.md +1 -1
- data/docs/OrganizationalUnitsApi.md +1 -1
- data/docs/StatisticGroupedEntry.md +35 -0
- data/docs/StatisticsApi.md +68 -0
- data/docs/TicketEntry.md +3 -1
- data/docs/TicketEntryLog.md +1 -3
- data/docs/TicketsApi.md +163 -78
- data/korona-entry-client-1.0.1.gem +0 -0
- data/lib/korona-entry-client.rb +2 -0
- data/lib/korona-entry-client/api/statistics_api.rb +126 -0
- data/lib/korona-entry-client/api/tickets_api.rb +237 -11
- data/lib/korona-entry-client/configuration.rb +2 -2
- data/lib/korona-entry-client/models/statistic_grouped_entry.rb +321 -0
- data/lib/korona-entry-client/models/ticket_entry.rb +14 -4
- data/lib/korona-entry-client/models/ticket_entry_log.rb +5 -15
- data/lib/korona-entry-client/version.rb +1 -1
- data/spec/api/statistics_api_spec.rb +52 -0
- data/spec/models/statistic_grouped_entry_spec.rb +99 -0
- metadata +11 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ddb36d2d40d2b0308cf04c46350d44d94244497fb7389d3b2163d5647ef31365
|
4
|
+
data.tar.gz: aabdb613695e90e24bdf4b9cda2f1688e272559c57a96c80716ef23c97766cca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 79c7f4811ab68a5509b412cb727619f5896ebf2001f2e816b1de15a0640a4f611a8f8d52e4d97eeb0497d6ddc4c399992ce85727c3889224c0ef448f956a1b0e
|
7
|
+
data.tar.gz: d925c6748a8da332d531b54f52c7a2138d13c3509d1f42fe0ad5bff530e1af5175b098fd28c5d63004f111f81515bb0bbc040095a6ef4d534936ea562b3246d3
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ Our api provides access to our entry services
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 1.0.
|
10
|
+
- Package version: 1.0.2
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build korona-entry-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./korona-entry-client-1.0.
|
26
|
+
gem install ./korona-entry-client-1.0.2.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./korona-entry-client-1.0.
|
29
|
+
(for development, run `gem install --dev ./korona-entry-client-1.0.2.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'korona-entry-client', '~> 1.0.
|
35
|
+
gem 'korona-entry-client', '~> 1.0.2'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -72,7 +72,7 @@ end
|
|
72
72
|
|
73
73
|
## Documentation for API Endpoints
|
74
74
|
|
75
|
-
All URIs are relative to *https://YourLocalInstance.com/korona.
|
75
|
+
All URIs are relative to *https://YourLocalInstance.com/korona.entry/services/v1*
|
76
76
|
|
77
77
|
Class | Method | HTTP request | Description
|
78
78
|
------------ | ------------- | ------------- | -------------
|
@@ -86,10 +86,13 @@ Class | Method | HTTP request | Description
|
|
86
86
|
*KoronaEntryClient::OrganizationalUnitsApi* | [**get_organizational_unit**](docs/OrganizationalUnitsApi.md#get_organizational_unit) | **GET** /{client}/organizationalUnits/{organizationalUnitId} | Returns the single organizational unit.
|
87
87
|
*KoronaEntryClient::OrganizationalUnitsApi* | [**get_organizational_units**](docs/OrganizationalUnitsApi.md#get_organizational_units) | **GET** /{client}/organizationalUnits | Returns all organizational unit
|
88
88
|
*KoronaEntryClient::OrganizationalUnitsApi* | [**update_organizational_unit**](docs/OrganizationalUnitsApi.md#update_organizational_unit) | **PATCH** /{client}/organizationalUnits/{organizationalUnitId} | Updates the single organizational unit.
|
89
|
+
*KoronaEntryClient::StatisticsApi* | [**load_grouped_entries**](docs/StatisticsApi.md#load_grouped_entries) | **GET** /{client}/statistics/groupedEntries | Prepares entries statistically and returns them as a list.
|
89
90
|
*KoronaEntryClient::TicketsApi* | [**check_ticket**](docs/TicketsApi.md#check_ticket) | **GET** /{client}/checkTicket | Checks a ticket. The entry can optionally also be committed.
|
90
91
|
*KoronaEntryClient::TicketsApi* | [**create_ticket**](docs/TicketsApi.md#create_ticket) | **POST** /{client}/tickets | Creates a new ticket.
|
92
|
+
*KoronaEntryClient::TicketsApi* | [**create_ticket_entry**](docs/TicketsApi.md#create_ticket_entry) | **POST** /{client}/tickets/{ticketId}/ticketEntries | Creates a new ticket entry for a specific ticket.
|
91
93
|
*KoronaEntryClient::TicketsApi* | [**delete_image**](docs/TicketsApi.md#delete_image) | **DELETE** /{client}/tickets/{ticketId}/image | Deletes the owners image of the ticket.
|
92
94
|
*KoronaEntryClient::TicketsApi* | [**delete_ticket**](docs/TicketsApi.md#delete_ticket) | **DELETE** /{client}/tickets/{ticketId} | Deletes the single ticket.
|
95
|
+
*KoronaEntryClient::TicketsApi* | [**delete_ticket_entry**](docs/TicketsApi.md#delete_ticket_entry) | **DELETE** /{client}/tickets/{ticketId}/ticketEntries/{ticketEntryId} | Deletes the single ticket entry (marks it as used up).
|
93
96
|
*KoronaEntryClient::TicketsApi* | [**get_image**](docs/TicketsApi.md#get_image) | **GET** /{client}/tickets/{ticketId}/image | Returns the owners image of the ticket
|
94
97
|
*KoronaEntryClient::TicketsApi* | [**get_logs**](docs/TicketsApi.md#get_logs) | **GET** /{client}/ticketEntryLogs | Returns the log for a optional single ticket and/or organizational unit
|
95
98
|
*KoronaEntryClient::TicketsApi* | [**get_ticket**](docs/TicketsApi.md#get_ticket) | **GET** /{client}/tickets/{ticketId} | Returns the single ticket.
|
@@ -97,6 +100,7 @@ Class | Method | HTTP request | Description
|
|
97
100
|
*KoronaEntryClient::TicketsApi* | [**get_tickets**](docs/TicketsApi.md#get_tickets) | **GET** /{client}/tickets | Lists all tickets.
|
98
101
|
*KoronaEntryClient::TicketsApi* | [**update_image**](docs/TicketsApi.md#update_image) | **POST** /{client}/tickets/{ticketId}/image | Updates the owners image of the ticket
|
99
102
|
*KoronaEntryClient::TicketsApi* | [**update_ticket**](docs/TicketsApi.md#update_ticket) | **PATCH** /{client}/tickets/{ticketId} | Updates the single ticket.
|
103
|
+
*KoronaEntryClient::TicketsApi* | [**update_ticket_entry**](docs/TicketsApi.md#update_ticket_entry) | **PATCH** /{client}/tickets/{ticketId}/ticketEntries/{ticketEntryId} | Updates the single ticket entry.
|
100
104
|
|
101
105
|
|
102
106
|
## Documentation for Models
|
@@ -109,6 +113,7 @@ Class | Method | HTTP request | Description
|
|
109
113
|
- [KoronaEntryClient::NotAcceptableError](docs/NotAcceptableError.md)
|
110
114
|
- [KoronaEntryClient::OrganizationalUnit](docs/OrganizationalUnit.md)
|
111
115
|
- [KoronaEntryClient::OrganizationalUnitList](docs/OrganizationalUnitList.md)
|
116
|
+
- [KoronaEntryClient::StatisticGroupedEntry](docs/StatisticGroupedEntry.md)
|
112
117
|
- [KoronaEntryClient::Ticket](docs/Ticket.md)
|
113
118
|
- [KoronaEntryClient::TicketEntry](docs/TicketEntry.md)
|
114
119
|
- [KoronaEntryClient::TicketEntryLog](docs/TicketEntryLog.md)
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# KoronaEntryClient::ExternalTicketConfigurationsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://YourLocalInstance.com/korona.
|
3
|
+
All URIs are relative to *https://YourLocalInstance.com/korona.entry/services/v1*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
@@ -1,6 +1,6 @@
|
|
1
1
|
# KoronaEntryClient::OrganizationalUnitsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://YourLocalInstance.com/korona.
|
3
|
+
All URIs are relative to *https://YourLocalInstance.com/korona.entry/services/v1*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# KoronaEntryClient::StatisticGroupedEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**article_number** | **String** | | [optional]
|
8
|
+
**year** | **Integer** | | [optional]
|
9
|
+
**month** | **Integer** | | [optional]
|
10
|
+
**day** | **Integer** | | [optional]
|
11
|
+
**hour** | **Integer** | | [optional]
|
12
|
+
**commit_type** | **String** | | [optional]
|
13
|
+
**entries** | **Integer** | | [optional]
|
14
|
+
**tickets** | **Integer** | | [optional]
|
15
|
+
**organizational_unit_number** | **String** | | [optional]
|
16
|
+
**tag** | **String** | | [optional]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'KoronaEntryClient'
|
22
|
+
|
23
|
+
instance = KoronaEntryClient::StatisticGroupedEntry.new(article_number: null,
|
24
|
+
year: null,
|
25
|
+
month: null,
|
26
|
+
day: null,
|
27
|
+
hour: null,
|
28
|
+
commit_type: null,
|
29
|
+
entries: null,
|
30
|
+
tickets: null,
|
31
|
+
organizational_unit_number: null,
|
32
|
+
tag: null)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# KoronaEntryClient::StatisticsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://YourLocalInstance.com/korona.entry/services/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**load_grouped_entries**](StatisticsApi.md#load_grouped_entries) | **GET** /{client}/statistics/groupedEntries | Prepares entries statistically and returns them as a list.
|
8
|
+
|
9
|
+
|
10
|
+
|
11
|
+
## load_grouped_entries
|
12
|
+
|
13
|
+
> Array<StatisticGroupedEntry> load_grouped_entries(client, time_from, time_to, ticket_type, grouped_entries_type, opts)
|
14
|
+
|
15
|
+
Prepares entries statistically and returns them as a list.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'korona-entry-client'
|
22
|
+
|
23
|
+
api_instance = KoronaEntryClient::StatisticsApi.new
|
24
|
+
client = 'client_example' # String | Identification of executing client.
|
25
|
+
time_from = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Log time from.
|
26
|
+
time_to = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Log time to.
|
27
|
+
ticket_type = 'ticket_type_example' # String |
|
28
|
+
grouped_entries_type = 'grouped_entries_type_example' # String |
|
29
|
+
opts = {
|
30
|
+
organizational_unit_numbers: ['organizational_unit_numbers_example'], # Array<String> |
|
31
|
+
tags: ['tags_example'] # Array<String> |
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Prepares entries statistically and returns them as a list.
|
36
|
+
result = api_instance.load_grouped_entries(client, time_from, time_to, ticket_type, grouped_entries_type, opts)
|
37
|
+
p result
|
38
|
+
rescue KoronaEntryClient::ApiError => e
|
39
|
+
puts "Exception when calling StatisticsApi->load_grouped_entries: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
|
45
|
+
|
46
|
+
Name | Type | Description | Notes
|
47
|
+
------------- | ------------- | ------------- | -------------
|
48
|
+
**client** | **String**| Identification of executing client. |
|
49
|
+
**time_from** | **DateTime**| Log time from. |
|
50
|
+
**time_to** | **DateTime**| Log time to. |
|
51
|
+
**ticket_type** | **String**| |
|
52
|
+
**grouped_entries_type** | **String**| |
|
53
|
+
**organizational_unit_numbers** | [**Array<String>**](String.md)| | [optional]
|
54
|
+
**tags** | [**Array<String>**](String.md)| | [optional]
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
[**Array<StatisticGroupedEntry>**](StatisticGroupedEntry.md)
|
59
|
+
|
60
|
+
### Authorization
|
61
|
+
|
62
|
+
No authorization required
|
63
|
+
|
64
|
+
### HTTP request headers
|
65
|
+
|
66
|
+
- **Content-Type**: Not defined
|
67
|
+
- **Accept**: application/json
|
68
|
+
|
data/docs/TicketEntry.md
CHANGED
@@ -21,6 +21,7 @@ Name | Type | Description | Notes
|
|
21
21
|
**information** | [**TicketInformation**](TicketInformation.md) | | [optional]
|
22
22
|
**locked_to** | **DateTime** | Date until which the ticketEntry is locked. | [optional]
|
23
23
|
**re_entry_lock** | **Integer** | Specifies how many seconds the ticket should be locked after a successful entry. | [optional]
|
24
|
+
**lock_for_period_after_use** | **String** | Specifies a time period after which the ticket is locked from the first use. The standard ISO 8601 format is used - PyYmMwWdDThHmMsS. Note that weeks should not be shown if any other field is present and vice versa. | [optional]
|
24
25
|
|
25
26
|
## Code Sample
|
26
27
|
|
@@ -43,7 +44,8 @@ instance = KoronaEntryClient::TicketEntry.new(id: null,
|
|
43
44
|
entry_gates: null,
|
44
45
|
information: null,
|
45
46
|
locked_to: null,
|
46
|
-
re_entry_lock: null
|
47
|
+
re_entry_lock: null,
|
48
|
+
lock_for_period_after_use: null)
|
47
49
|
```
|
48
50
|
|
49
51
|
|
data/docs/TicketEntryLog.md
CHANGED
@@ -15,7 +15,6 @@ Name | Type | Description | Notes
|
|
15
15
|
**client** | **String** | Client concerned. | [optional]
|
16
16
|
**number_of_uses** | **Integer** | Number of uses if its an entry action. | [optional]
|
17
17
|
**commit_type** | **String** | Identification of commit type. | [optional]
|
18
|
-
**test_time** | **DateTime** | Time of testing. | [optional]
|
19
18
|
|
20
19
|
## Code Sample
|
21
20
|
|
@@ -32,8 +31,7 @@ instance = KoronaEntryClient::TicketEntryLog.new(id: null,
|
|
32
31
|
organizational_unit_number: null,
|
33
32
|
client: null,
|
34
33
|
number_of_uses: null,
|
35
|
-
commit_type: null
|
36
|
-
test_time: null)
|
34
|
+
commit_type: null)
|
37
35
|
```
|
38
36
|
|
39
37
|
|
data/docs/TicketsApi.md
CHANGED
@@ -1,13 +1,15 @@
|
|
1
1
|
# KoronaEntryClient::TicketsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://YourLocalInstance.com/korona.
|
3
|
+
All URIs are relative to *https://YourLocalInstance.com/korona.entry/services/v1*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**check_ticket**](TicketsApi.md#check_ticket) | **GET** /{client}/checkTicket | Checks a ticket. The entry can optionally also be committed.
|
8
8
|
[**create_ticket**](TicketsApi.md#create_ticket) | **POST** /{client}/tickets | Creates a new ticket.
|
9
|
+
[**create_ticket_entry**](TicketsApi.md#create_ticket_entry) | **POST** /{client}/tickets/{ticketId}/ticketEntries | Creates a new ticket entry for a specific ticket.
|
9
10
|
[**delete_image**](TicketsApi.md#delete_image) | **DELETE** /{client}/tickets/{ticketId}/image | Deletes the owners image of the ticket.
|
10
11
|
[**delete_ticket**](TicketsApi.md#delete_ticket) | **DELETE** /{client}/tickets/{ticketId} | Deletes the single ticket.
|
12
|
+
[**delete_ticket_entry**](TicketsApi.md#delete_ticket_entry) | **DELETE** /{client}/tickets/{ticketId}/ticketEntries/{ticketEntryId} | Deletes the single ticket entry (marks it as used up).
|
11
13
|
[**get_image**](TicketsApi.md#get_image) | **GET** /{client}/tickets/{ticketId}/image | Returns the owners image of the ticket
|
12
14
|
[**get_logs**](TicketsApi.md#get_logs) | **GET** /{client}/ticketEntryLogs | Returns the log for a optional single ticket and/or organizational unit
|
13
15
|
[**get_ticket**](TicketsApi.md#get_ticket) | **GET** /{client}/tickets/{ticketId} | Returns the single ticket.
|
@@ -15,6 +17,7 @@ Method | HTTP request | Description
|
|
15
17
|
[**get_tickets**](TicketsApi.md#get_tickets) | **GET** /{client}/tickets | Lists all tickets.
|
16
18
|
[**update_image**](TicketsApi.md#update_image) | **POST** /{client}/tickets/{ticketId}/image | Updates the owners image of the ticket
|
17
19
|
[**update_ticket**](TicketsApi.md#update_ticket) | **PATCH** /{client}/tickets/{ticketId} | Updates the single ticket.
|
20
|
+
[**update_ticket_entry**](TicketsApi.md#update_ticket_entry) | **PATCH** /{client}/tickets/{ticketId}/ticketEntries/{ticketEntryId} | Updates the single ticket entry.
|
18
21
|
|
19
22
|
|
20
23
|
|
@@ -29,12 +32,6 @@ Checks a ticket. The entry can optionally also be committed.
|
|
29
32
|
```ruby
|
30
33
|
# load the gem
|
31
34
|
require 'korona-entry-client'
|
32
|
-
# setup authorization
|
33
|
-
KoronaEntryClient.configure do |config|
|
34
|
-
# Configure HTTP basic authorization: basicAuth
|
35
|
-
config.username = 'YOUR USERNAME'
|
36
|
-
config.password = 'YOUR PASSWORD'
|
37
|
-
end
|
38
35
|
|
39
36
|
api_instance = KoronaEntryClient::TicketsApi.new
|
40
37
|
client = 'client_example' # String | Identification of executing client.
|
@@ -75,7 +72,7 @@ Name | Type | Description | Notes
|
|
75
72
|
|
76
73
|
### Authorization
|
77
74
|
|
78
|
-
|
75
|
+
No authorization required
|
79
76
|
|
80
77
|
### HTTP request headers
|
81
78
|
|
@@ -94,12 +91,6 @@ Creates a new ticket.
|
|
94
91
|
```ruby
|
95
92
|
# load the gem
|
96
93
|
require 'korona-entry-client'
|
97
|
-
# setup authorization
|
98
|
-
KoronaEntryClient.configure do |config|
|
99
|
-
# Configure HTTP basic authorization: basicAuth
|
100
|
-
config.username = 'YOUR USERNAME'
|
101
|
-
config.password = 'YOUR PASSWORD'
|
102
|
-
end
|
103
94
|
|
104
95
|
api_instance = KoronaEntryClient::TicketsApi.new
|
105
96
|
client = 'client_example' # String | Identification of executing client.
|
@@ -128,7 +119,56 @@ Name | Type | Description | Notes
|
|
128
119
|
|
129
120
|
### Authorization
|
130
121
|
|
131
|
-
|
122
|
+
No authorization required
|
123
|
+
|
124
|
+
### HTTP request headers
|
125
|
+
|
126
|
+
- **Content-Type**: application/json
|
127
|
+
- **Accept**: application/json
|
128
|
+
|
129
|
+
|
130
|
+
## create_ticket_entry
|
131
|
+
|
132
|
+
> ModelReference create_ticket_entry(client, ticket_id, body)
|
133
|
+
|
134
|
+
Creates a new ticket entry for a specific ticket.
|
135
|
+
|
136
|
+
### Example
|
137
|
+
|
138
|
+
```ruby
|
139
|
+
# load the gem
|
140
|
+
require 'korona-entry-client'
|
141
|
+
|
142
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
143
|
+
client = 'client_example' # String | Identification of executing client.
|
144
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
145
|
+
body = KoronaEntryClient::TicketEntry.new # TicketEntry | Properties to update of the ticket entry.
|
146
|
+
|
147
|
+
begin
|
148
|
+
#Creates a new ticket entry for a specific ticket.
|
149
|
+
result = api_instance.create_ticket_entry(client, ticket_id, body)
|
150
|
+
p result
|
151
|
+
rescue KoronaEntryClient::ApiError => e
|
152
|
+
puts "Exception when calling TicketsApi->create_ticket_entry: #{e}"
|
153
|
+
end
|
154
|
+
```
|
155
|
+
|
156
|
+
### Parameters
|
157
|
+
|
158
|
+
|
159
|
+
Name | Type | Description | Notes
|
160
|
+
------------- | ------------- | ------------- | -------------
|
161
|
+
**client** | **String**| Identification of executing client. |
|
162
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
163
|
+
**body** | [**TicketEntry**](TicketEntry.md)| Properties to update of the ticket entry. |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**ModelReference**](ModelReference.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
No authorization required
|
132
172
|
|
133
173
|
### HTTP request headers
|
134
174
|
|
@@ -147,12 +187,6 @@ Deletes the owners image of the ticket.
|
|
147
187
|
```ruby
|
148
188
|
# load the gem
|
149
189
|
require 'korona-entry-client'
|
150
|
-
# setup authorization
|
151
|
-
KoronaEntryClient.configure do |config|
|
152
|
-
# Configure HTTP basic authorization: basicAuth
|
153
|
-
config.username = 'YOUR USERNAME'
|
154
|
-
config.password = 'YOUR PASSWORD'
|
155
|
-
end
|
156
190
|
|
157
191
|
api_instance = KoronaEntryClient::TicketsApi.new
|
158
192
|
client = 'client_example' # String | Identification of executing client.
|
@@ -180,7 +214,7 @@ nil (empty response body)
|
|
180
214
|
|
181
215
|
### Authorization
|
182
216
|
|
183
|
-
|
217
|
+
No authorization required
|
184
218
|
|
185
219
|
### HTTP request headers
|
186
220
|
|
@@ -199,12 +233,6 @@ Deletes the single ticket.
|
|
199
233
|
```ruby
|
200
234
|
# load the gem
|
201
235
|
require 'korona-entry-client'
|
202
|
-
# setup authorization
|
203
|
-
KoronaEntryClient.configure do |config|
|
204
|
-
# Configure HTTP basic authorization: basicAuth
|
205
|
-
config.username = 'YOUR USERNAME'
|
206
|
-
config.password = 'YOUR PASSWORD'
|
207
|
-
end
|
208
236
|
|
209
237
|
api_instance = KoronaEntryClient::TicketsApi.new
|
210
238
|
client = 'client_example' # String | Identification of executing client.
|
@@ -232,7 +260,55 @@ nil (empty response body)
|
|
232
260
|
|
233
261
|
### Authorization
|
234
262
|
|
235
|
-
|
263
|
+
No authorization required
|
264
|
+
|
265
|
+
### HTTP request headers
|
266
|
+
|
267
|
+
- **Content-Type**: Not defined
|
268
|
+
- **Accept**: application/json
|
269
|
+
|
270
|
+
|
271
|
+
## delete_ticket_entry
|
272
|
+
|
273
|
+
> delete_ticket_entry(client, ticket_id, ticket_entry_id)
|
274
|
+
|
275
|
+
Deletes the single ticket entry (marks it as used up).
|
276
|
+
|
277
|
+
### Example
|
278
|
+
|
279
|
+
```ruby
|
280
|
+
# load the gem
|
281
|
+
require 'korona-entry-client'
|
282
|
+
|
283
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
284
|
+
client = 'client_example' # String | Identification of executing client.
|
285
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
286
|
+
ticket_entry_id = 56 # Integer | ID to identify the ticket entry of the ticket.
|
287
|
+
|
288
|
+
begin
|
289
|
+
#Deletes the single ticket entry (marks it as used up).
|
290
|
+
api_instance.delete_ticket_entry(client, ticket_id, ticket_entry_id)
|
291
|
+
rescue KoronaEntryClient::ApiError => e
|
292
|
+
puts "Exception when calling TicketsApi->delete_ticket_entry: #{e}"
|
293
|
+
end
|
294
|
+
```
|
295
|
+
|
296
|
+
### Parameters
|
297
|
+
|
298
|
+
|
299
|
+
Name | Type | Description | Notes
|
300
|
+
------------- | ------------- | ------------- | -------------
|
301
|
+
**client** | **String**| Identification of executing client. |
|
302
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
303
|
+
**ticket_entry_id** | **Integer**| ID to identify the ticket entry of the ticket. |
|
304
|
+
|
305
|
+
### Return type
|
306
|
+
|
307
|
+
nil (empty response body)
|
308
|
+
|
309
|
+
### Authorization
|
310
|
+
|
311
|
+
No authorization required
|
236
312
|
|
237
313
|
### HTTP request headers
|
238
314
|
|
@@ -251,12 +327,6 @@ Returns the owners image of the ticket
|
|
251
327
|
```ruby
|
252
328
|
# load the gem
|
253
329
|
require 'korona-entry-client'
|
254
|
-
# setup authorization
|
255
|
-
KoronaEntryClient.configure do |config|
|
256
|
-
# Configure HTTP basic authorization: basicAuth
|
257
|
-
config.username = 'YOUR USERNAME'
|
258
|
-
config.password = 'YOUR PASSWORD'
|
259
|
-
end
|
260
330
|
|
261
331
|
api_instance = KoronaEntryClient::TicketsApi.new
|
262
332
|
client = 'client_example' # String | Identification of executing client.
|
@@ -285,7 +355,7 @@ Name | Type | Description | Notes
|
|
285
355
|
|
286
356
|
### Authorization
|
287
357
|
|
288
|
-
|
358
|
+
No authorization required
|
289
359
|
|
290
360
|
### HTTP request headers
|
291
361
|
|
@@ -304,12 +374,6 @@ Returns the log for a optional single ticket and/or organizational unit
|
|
304
374
|
```ruby
|
305
375
|
# load the gem
|
306
376
|
require 'korona-entry-client'
|
307
|
-
# setup authorization
|
308
|
-
KoronaEntryClient.configure do |config|
|
309
|
-
# Configure HTTP basic authorization: basicAuth
|
310
|
-
config.username = 'YOUR USERNAME'
|
311
|
-
config.password = 'YOUR PASSWORD'
|
312
|
-
end
|
313
377
|
|
314
378
|
api_instance = KoronaEntryClient::TicketsApi.new
|
315
379
|
client = 'client_example' # String | Identification of executing client.
|
@@ -348,7 +412,7 @@ Name | Type | Description | Notes
|
|
348
412
|
|
349
413
|
### Authorization
|
350
414
|
|
351
|
-
|
415
|
+
No authorization required
|
352
416
|
|
353
417
|
### HTTP request headers
|
354
418
|
|
@@ -367,12 +431,6 @@ Returns the single ticket.
|
|
367
431
|
```ruby
|
368
432
|
# load the gem
|
369
433
|
require 'korona-entry-client'
|
370
|
-
# setup authorization
|
371
|
-
KoronaEntryClient.configure do |config|
|
372
|
-
# Configure HTTP basic authorization: basicAuth
|
373
|
-
config.username = 'YOUR USERNAME'
|
374
|
-
config.password = 'YOUR PASSWORD'
|
375
|
-
end
|
376
434
|
|
377
435
|
api_instance = KoronaEntryClient::TicketsApi.new
|
378
436
|
client = 'client_example' # String | Identification of executing client.
|
@@ -401,7 +459,7 @@ Name | Type | Description | Notes
|
|
401
459
|
|
402
460
|
### Authorization
|
403
461
|
|
404
|
-
|
462
|
+
No authorization required
|
405
463
|
|
406
464
|
### HTTP request headers
|
407
465
|
|
@@ -420,12 +478,6 @@ Returns a single ticket entry.
|
|
420
478
|
```ruby
|
421
479
|
# load the gem
|
422
480
|
require 'korona-entry-client'
|
423
|
-
# setup authorization
|
424
|
-
KoronaEntryClient.configure do |config|
|
425
|
-
# Configure HTTP basic authorization: basicAuth
|
426
|
-
config.username = 'YOUR USERNAME'
|
427
|
-
config.password = 'YOUR PASSWORD'
|
428
|
-
end
|
429
481
|
|
430
482
|
api_instance = KoronaEntryClient::TicketsApi.new
|
431
483
|
client = 'client_example' # String | Identification of executing client.
|
@@ -456,7 +508,7 @@ Name | Type | Description | Notes
|
|
456
508
|
|
457
509
|
### Authorization
|
458
510
|
|
459
|
-
|
511
|
+
No authorization required
|
460
512
|
|
461
513
|
### HTTP request headers
|
462
514
|
|
@@ -475,12 +527,6 @@ Lists all tickets.
|
|
475
527
|
```ruby
|
476
528
|
# load the gem
|
477
529
|
require 'korona-entry-client'
|
478
|
-
# setup authorization
|
479
|
-
KoronaEntryClient.configure do |config|
|
480
|
-
# Configure HTTP basic authorization: basicAuth
|
481
|
-
config.username = 'YOUR USERNAME'
|
482
|
-
config.password = 'YOUR PASSWORD'
|
483
|
-
end
|
484
530
|
|
485
531
|
api_instance = KoronaEntryClient::TicketsApi.new
|
486
532
|
client = 'client_example' # String | Identification of executing client.
|
@@ -535,7 +581,7 @@ Name | Type | Description | Notes
|
|
535
581
|
|
536
582
|
### Authorization
|
537
583
|
|
538
|
-
|
584
|
+
No authorization required
|
539
585
|
|
540
586
|
### HTTP request headers
|
541
587
|
|
@@ -554,12 +600,6 @@ Updates the owners image of the ticket
|
|
554
600
|
```ruby
|
555
601
|
# load the gem
|
556
602
|
require 'korona-entry-client'
|
557
|
-
# setup authorization
|
558
|
-
KoronaEntryClient.configure do |config|
|
559
|
-
# Configure HTTP basic authorization: basicAuth
|
560
|
-
config.username = 'YOUR USERNAME'
|
561
|
-
config.password = 'YOUR PASSWORD'
|
562
|
-
end
|
563
603
|
|
564
604
|
api_instance = KoronaEntryClient::TicketsApi.new
|
565
605
|
client = 'client_example' # String | Identification of executing client.
|
@@ -590,7 +630,7 @@ Name | Type | Description | Notes
|
|
590
630
|
|
591
631
|
### Authorization
|
592
632
|
|
593
|
-
|
633
|
+
No authorization required
|
594
634
|
|
595
635
|
### HTTP request headers
|
596
636
|
|
@@ -609,12 +649,6 @@ Updates the single ticket.
|
|
609
649
|
```ruby
|
610
650
|
# load the gem
|
611
651
|
require 'korona-entry-client'
|
612
|
-
# setup authorization
|
613
|
-
KoronaEntryClient.configure do |config|
|
614
|
-
# Configure HTTP basic authorization: basicAuth
|
615
|
-
config.username = 'YOUR USERNAME'
|
616
|
-
config.password = 'YOUR PASSWORD'
|
617
|
-
end
|
618
652
|
|
619
653
|
api_instance = KoronaEntryClient::TicketsApi.new
|
620
654
|
client = 'client_example' # String | Identification of executing client.
|
@@ -645,7 +679,58 @@ Name | Type | Description | Notes
|
|
645
679
|
|
646
680
|
### Authorization
|
647
681
|
|
648
|
-
|
682
|
+
No authorization required
|
683
|
+
|
684
|
+
### HTTP request headers
|
685
|
+
|
686
|
+
- **Content-Type**: application/json
|
687
|
+
- **Accept**: application/json
|
688
|
+
|
689
|
+
|
690
|
+
## update_ticket_entry
|
691
|
+
|
692
|
+
> ModelReference update_ticket_entry(client, ticket_id, ticket_entry_id, body)
|
693
|
+
|
694
|
+
Updates the single ticket entry.
|
695
|
+
|
696
|
+
### Example
|
697
|
+
|
698
|
+
```ruby
|
699
|
+
# load the gem
|
700
|
+
require 'korona-entry-client'
|
701
|
+
|
702
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
703
|
+
client = 'client_example' # String | Identification of executing client.
|
704
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
705
|
+
ticket_entry_id = 56 # Integer | ID to identify the ticket entry of the ticket.
|
706
|
+
body = KoronaEntryClient::TicketEntry.new # TicketEntry | Properties to update of the ticket entry.
|
707
|
+
|
708
|
+
begin
|
709
|
+
#Updates the single ticket entry.
|
710
|
+
result = api_instance.update_ticket_entry(client, ticket_id, ticket_entry_id, body)
|
711
|
+
p result
|
712
|
+
rescue KoronaEntryClient::ApiError => e
|
713
|
+
puts "Exception when calling TicketsApi->update_ticket_entry: #{e}"
|
714
|
+
end
|
715
|
+
```
|
716
|
+
|
717
|
+
### Parameters
|
718
|
+
|
719
|
+
|
720
|
+
Name | Type | Description | Notes
|
721
|
+
------------- | ------------- | ------------- | -------------
|
722
|
+
**client** | **String**| Identification of executing client. |
|
723
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
724
|
+
**ticket_entry_id** | **Integer**| ID to identify the ticket entry of the ticket. |
|
725
|
+
**body** | [**TicketEntry**](TicketEntry.md)| Properties to update of the ticket entry. |
|
726
|
+
|
727
|
+
### Return type
|
728
|
+
|
729
|
+
[**ModelReference**](ModelReference.md)
|
730
|
+
|
731
|
+
### Authorization
|
732
|
+
|
733
|
+
No authorization required
|
649
734
|
|
650
735
|
### HTTP request headers
|
651
736
|
|