korona-entry-client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +128 -0
- data/Rakefile +10 -0
- data/docs/BadRequestError.md +19 -0
- data/docs/EntryResponse.md +21 -0
- data/docs/ExternalTicketConfiguration.md +29 -0
- data/docs/ExternalTicketConfigurationList.md +17 -0
- data/docs/ExternalTicketConfigurationsApi.md +247 -0
- data/docs/ModelReference.md +23 -0
- data/docs/NotAcceptableError.md +19 -0
- data/docs/OrganizationalUnit.md +27 -0
- data/docs/OrganizationalUnitList.md +17 -0
- data/docs/OrganizationalUnitsApi.md +247 -0
- data/docs/Ticket.md +35 -0
- data/docs/TicketEntry.md +49 -0
- data/docs/TicketEntryLog.md +39 -0
- data/docs/TicketEntryLogList.md +17 -0
- data/docs/TicketImage.md +17 -0
- data/docs/TicketInformation.md +27 -0
- data/docs/TicketList.md +17 -0
- data/docs/TicketPersonalization.md +21 -0
- data/docs/TicketsApi.md +654 -0
- data/git_push.sh +58 -0
- data/korona-entry-client.gemspec +39 -0
- data/lib/korona-entry-client.rb +58 -0
- data/lib/korona-entry-client/api/external_ticket_configurations_api.rb +356 -0
- data/lib/korona-entry-client/api/organizational_units_api.rb +356 -0
- data/lib/korona-entry-client/api/tickets_api.rb +854 -0
- data/lib/korona-entry-client/api_client.rb +386 -0
- data/lib/korona-entry-client/api_error.rb +57 -0
- data/lib/korona-entry-client/configuration.rb +248 -0
- data/lib/korona-entry-client/models/bad_request_error.rb +217 -0
- data/lib/korona-entry-client/models/entry_response.rb +226 -0
- data/lib/korona-entry-client/models/external_ticket_configuration.rb +304 -0
- data/lib/korona-entry-client/models/external_ticket_configuration_list.rb +214 -0
- data/lib/korona-entry-client/models/model_reference.rb +238 -0
- data/lib/korona-entry-client/models/not_acceptable_error.rb +250 -0
- data/lib/korona-entry-client/models/organizational_unit.rb +257 -0
- data/lib/korona-entry-client/models/organizational_unit_list.rb +214 -0
- data/lib/korona-entry-client/models/ticket.rb +299 -0
- data/lib/korona-entry-client/models/ticket_entry.rb +403 -0
- data/lib/korona-entry-client/models/ticket_entry_log.rb +374 -0
- data/lib/korona-entry-client/models/ticket_entry_log_list.rb +214 -0
- data/lib/korona-entry-client/models/ticket_image.rb +215 -0
- data/lib/korona-entry-client/models/ticket_information.rb +258 -0
- data/lib/korona-entry-client/models/ticket_list.rb +214 -0
- data/lib/korona-entry-client/models/ticket_personalization.rb +228 -0
- data/lib/korona-entry-client/version.rb +15 -0
- data/spec/api/external_ticket_configurations_api_spec.rb +95 -0
- data/spec/api/organizational_units_api_spec.rb +95 -0
- data/spec/api/tickets_api_spec.rb +191 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/bad_request_error_spec.rb +47 -0
- data/spec/models/entry_response_spec.rb +53 -0
- data/spec/models/external_ticket_configuration_list_spec.rb +41 -0
- data/spec/models/external_ticket_configuration_spec.rb +77 -0
- data/spec/models/model_reference_spec.rb +59 -0
- data/spec/models/not_acceptable_error_spec.rb +51 -0
- data/spec/models/organizational_unit_list_spec.rb +41 -0
- data/spec/models/organizational_unit_spec.rb +71 -0
- data/spec/models/ticket_entry_log_list_spec.rb +41 -0
- data/spec/models/ticket_entry_log_spec.rb +119 -0
- data/spec/models/ticket_entry_spec.rb +137 -0
- data/spec/models/ticket_image_spec.rb +41 -0
- data/spec/models/ticket_information_spec.rb +71 -0
- data/spec/models/ticket_list_spec.rb +41 -0
- data/spec/models/ticket_personalization_spec.rb +53 -0
- data/spec/models/ticket_spec.rb +95 -0
- data/spec/spec_helper.rb +111 -0
- metadata +196 -0
@@ -0,0 +1,17 @@
|
|
1
|
+
# KoronaEntryClient::TicketEntryLogList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**ticket_entry_logs** | [**Array<TicketEntryLog>**](TicketEntryLog.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'KoronaEntryClient'
|
13
|
+
|
14
|
+
instance = KoronaEntryClient::TicketEntryLogList.new(ticket_entry_logs: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/TicketImage.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# KoronaEntryClient::TicketImage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**data** | **Array<String>** | The image data. |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'KoronaEntryClient'
|
13
|
+
|
14
|
+
instance = KoronaEntryClient::TicketImage.new(data: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# KoronaEntryClient::TicketInformation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**tag** | **String** | Optional information to categorize tickets by entries. | [optional]
|
8
|
+
**count_statistically** | **Boolean** | Optional information. *True*, if an access by this TicketEntry should count statistically (f.e. customers or employees). | [optional]
|
9
|
+
**ticket_value** | **Float** | Optional information that represents the sale value of this TicketEntry. | [optional]
|
10
|
+
**entry_signal** | **String** | Optional information for the presentation of the ticket by this entry. | [optional]
|
11
|
+
**product_number** | **String** | Number of the associated article. | [optional]
|
12
|
+
**receipt_number** | **String** | Number of the receipt by which the ticket was created. | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'KoronaEntryClient'
|
18
|
+
|
19
|
+
instance = KoronaEntryClient::TicketInformation.new(tag: null,
|
20
|
+
count_statistically: null,
|
21
|
+
ticket_value: null,
|
22
|
+
entry_signal: null,
|
23
|
+
product_number: null,
|
24
|
+
receipt_number: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
data/docs/TicketList.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# KoronaEntryClient::TicketList
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**tickets** | [**Array<Ticket>**](Ticket.md) | |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'KoronaEntryClient'
|
13
|
+
|
14
|
+
instance = KoronaEntryClient::TicketList.new(tickets: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# KoronaEntryClient::TicketPersonalization
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**firstname** | **String** | Frist name of ticket owner. | [optional]
|
8
|
+
**lastname** | **String** | Last name of ticket owner. | [optional]
|
9
|
+
**customer_number** | **String** | Customer number of ticket owner. | [optional]
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'KoronaEntryClient'
|
15
|
+
|
16
|
+
instance = KoronaEntryClient::TicketPersonalization.new(firstname: null,
|
17
|
+
lastname: null,
|
18
|
+
customer_number: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
data/docs/TicketsApi.md
ADDED
@@ -0,0 +1,654 @@
|
|
1
|
+
# KoronaEntryClient::TicketsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://YourLocalInstance.com/korona.entry_server/services/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**check_ticket**](TicketsApi.md#check_ticket) | **GET** /{client}/checkTicket | Checks a ticket. The entry can optionally also be committed.
|
8
|
+
[**create_ticket**](TicketsApi.md#create_ticket) | **POST** /{client}/tickets | Creates a new ticket.
|
9
|
+
[**delete_image**](TicketsApi.md#delete_image) | **DELETE** /{client}/tickets/{ticketId}/image | Deletes the owners image of the ticket.
|
10
|
+
[**delete_ticket**](TicketsApi.md#delete_ticket) | **DELETE** /{client}/tickets/{ticketId} | Deletes the single ticket.
|
11
|
+
[**get_image**](TicketsApi.md#get_image) | **GET** /{client}/tickets/{ticketId}/image | Returns the owners image of the ticket
|
12
|
+
[**get_logs**](TicketsApi.md#get_logs) | **GET** /{client}/ticketEntryLogs | Returns the log for a optional single ticket and/or organizational unit
|
13
|
+
[**get_ticket**](TicketsApi.md#get_ticket) | **GET** /{client}/tickets/{ticketId} | Returns the single ticket.
|
14
|
+
[**get_ticket_entry**](TicketsApi.md#get_ticket_entry) | **GET** /{client}/tickets/{ticketId}/ticketEntries/{ticketEntryId} | Returns a single ticket entry.
|
15
|
+
[**get_tickets**](TicketsApi.md#get_tickets) | **GET** /{client}/tickets | Lists all tickets.
|
16
|
+
[**update_image**](TicketsApi.md#update_image) | **POST** /{client}/tickets/{ticketId}/image | Updates the owners image of the ticket
|
17
|
+
[**update_ticket**](TicketsApi.md#update_ticket) | **PATCH** /{client}/tickets/{ticketId} | Updates the single ticket.
|
18
|
+
|
19
|
+
|
20
|
+
|
21
|
+
## check_ticket
|
22
|
+
|
23
|
+
> EntryResponse check_ticket(client, ticket_number, opts)
|
24
|
+
|
25
|
+
Checks a ticket. The entry can optionally also be committed.
|
26
|
+
|
27
|
+
### Example
|
28
|
+
|
29
|
+
```ruby
|
30
|
+
# load the gem
|
31
|
+
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
|
+
|
39
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
40
|
+
client = 'client_example' # String | Identification of executing client.
|
41
|
+
ticket_number = 'ticket_number_example' # String | Ticket number to be checked.
|
42
|
+
opts = {
|
43
|
+
commit_entry: true, # Boolean | True if entry should be committed.
|
44
|
+
commit_type: 'commit_type_example', # String |
|
45
|
+
organizational_unit_number: 'organizational_unit_number_example', # String | Number of organizational unit.
|
46
|
+
time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The time to be checked. *Now* if not specified further.
|
47
|
+
number_of_uses: 56 # Integer | Number of uses. *1* if not specified further.
|
48
|
+
}
|
49
|
+
|
50
|
+
begin
|
51
|
+
#Checks a ticket. The entry can optionally also be committed.
|
52
|
+
result = api_instance.check_ticket(client, ticket_number, opts)
|
53
|
+
p result
|
54
|
+
rescue KoronaEntryClient::ApiError => e
|
55
|
+
puts "Exception when calling TicketsApi->check_ticket: #{e}"
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
### Parameters
|
60
|
+
|
61
|
+
|
62
|
+
Name | Type | Description | Notes
|
63
|
+
------------- | ------------- | ------------- | -------------
|
64
|
+
**client** | **String**| Identification of executing client. |
|
65
|
+
**ticket_number** | **String**| Ticket number to be checked. |
|
66
|
+
**commit_entry** | **Boolean**| True if entry should be committed. | [optional]
|
67
|
+
**commit_type** | **String**| | [optional]
|
68
|
+
**organizational_unit_number** | **String**| Number of organizational unit. | [optional]
|
69
|
+
**time** | **DateTime**| The time to be checked. *Now* if not specified further. | [optional]
|
70
|
+
**number_of_uses** | **Integer**| Number of uses. *1* if not specified further. | [optional]
|
71
|
+
|
72
|
+
### Return type
|
73
|
+
|
74
|
+
[**EntryResponse**](EntryResponse.md)
|
75
|
+
|
76
|
+
### Authorization
|
77
|
+
|
78
|
+
[basicAuth](../README.md#basicAuth)
|
79
|
+
|
80
|
+
### HTTP request headers
|
81
|
+
|
82
|
+
- **Content-Type**: Not defined
|
83
|
+
- **Accept**: application/json
|
84
|
+
|
85
|
+
|
86
|
+
## create_ticket
|
87
|
+
|
88
|
+
> ModelReference create_ticket(client, body)
|
89
|
+
|
90
|
+
Creates a new ticket.
|
91
|
+
|
92
|
+
### Example
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
# load the gem
|
96
|
+
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
|
+
|
104
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
105
|
+
client = 'client_example' # String | Identification of executing client.
|
106
|
+
body = KoronaEntryClient::Ticket.new # Ticket | Properties to update of the ticket.
|
107
|
+
|
108
|
+
begin
|
109
|
+
#Creates a new ticket.
|
110
|
+
result = api_instance.create_ticket(client, body)
|
111
|
+
p result
|
112
|
+
rescue KoronaEntryClient::ApiError => e
|
113
|
+
puts "Exception when calling TicketsApi->create_ticket: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
|
120
|
+
Name | Type | Description | Notes
|
121
|
+
------------- | ------------- | ------------- | -------------
|
122
|
+
**client** | **String**| Identification of executing client. |
|
123
|
+
**body** | [**Ticket**](Ticket.md)| Properties to update of the ticket. |
|
124
|
+
|
125
|
+
### Return type
|
126
|
+
|
127
|
+
[**ModelReference**](ModelReference.md)
|
128
|
+
|
129
|
+
### Authorization
|
130
|
+
|
131
|
+
[basicAuth](../README.md#basicAuth)
|
132
|
+
|
133
|
+
### HTTP request headers
|
134
|
+
|
135
|
+
- **Content-Type**: application/json
|
136
|
+
- **Accept**: application/json
|
137
|
+
|
138
|
+
|
139
|
+
## delete_image
|
140
|
+
|
141
|
+
> delete_image(client, ticket_id)
|
142
|
+
|
143
|
+
Deletes the owners image of the ticket.
|
144
|
+
|
145
|
+
### Example
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
# load the gem
|
149
|
+
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
|
+
|
157
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
158
|
+
client = 'client_example' # String | Identification of executing client.
|
159
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
160
|
+
|
161
|
+
begin
|
162
|
+
#Deletes the owners image of the ticket.
|
163
|
+
api_instance.delete_image(client, ticket_id)
|
164
|
+
rescue KoronaEntryClient::ApiError => e
|
165
|
+
puts "Exception when calling TicketsApi->delete_image: #{e}"
|
166
|
+
end
|
167
|
+
```
|
168
|
+
|
169
|
+
### Parameters
|
170
|
+
|
171
|
+
|
172
|
+
Name | Type | Description | Notes
|
173
|
+
------------- | ------------- | ------------- | -------------
|
174
|
+
**client** | **String**| Identification of executing client. |
|
175
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
176
|
+
|
177
|
+
### Return type
|
178
|
+
|
179
|
+
nil (empty response body)
|
180
|
+
|
181
|
+
### Authorization
|
182
|
+
|
183
|
+
[basicAuth](../README.md#basicAuth)
|
184
|
+
|
185
|
+
### HTTP request headers
|
186
|
+
|
187
|
+
- **Content-Type**: Not defined
|
188
|
+
- **Accept**: application/json
|
189
|
+
|
190
|
+
|
191
|
+
## delete_ticket
|
192
|
+
|
193
|
+
> delete_ticket(client, ticket_id)
|
194
|
+
|
195
|
+
Deletes the single ticket.
|
196
|
+
|
197
|
+
### Example
|
198
|
+
|
199
|
+
```ruby
|
200
|
+
# load the gem
|
201
|
+
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
|
+
|
209
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
210
|
+
client = 'client_example' # String | Identification of executing client.
|
211
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
212
|
+
|
213
|
+
begin
|
214
|
+
#Deletes the single ticket.
|
215
|
+
api_instance.delete_ticket(client, ticket_id)
|
216
|
+
rescue KoronaEntryClient::ApiError => e
|
217
|
+
puts "Exception when calling TicketsApi->delete_ticket: #{e}"
|
218
|
+
end
|
219
|
+
```
|
220
|
+
|
221
|
+
### Parameters
|
222
|
+
|
223
|
+
|
224
|
+
Name | Type | Description | Notes
|
225
|
+
------------- | ------------- | ------------- | -------------
|
226
|
+
**client** | **String**| Identification of executing client. |
|
227
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
228
|
+
|
229
|
+
### Return type
|
230
|
+
|
231
|
+
nil (empty response body)
|
232
|
+
|
233
|
+
### Authorization
|
234
|
+
|
235
|
+
[basicAuth](../README.md#basicAuth)
|
236
|
+
|
237
|
+
### HTTP request headers
|
238
|
+
|
239
|
+
- **Content-Type**: Not defined
|
240
|
+
- **Accept**: application/json
|
241
|
+
|
242
|
+
|
243
|
+
## get_image
|
244
|
+
|
245
|
+
> TicketImage get_image(client, ticket_id)
|
246
|
+
|
247
|
+
Returns the owners image of the ticket
|
248
|
+
|
249
|
+
### Example
|
250
|
+
|
251
|
+
```ruby
|
252
|
+
# load the gem
|
253
|
+
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
|
+
|
261
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
262
|
+
client = 'client_example' # String | Identification of executing client.
|
263
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
264
|
+
|
265
|
+
begin
|
266
|
+
#Returns the owners image of the ticket
|
267
|
+
result = api_instance.get_image(client, ticket_id)
|
268
|
+
p result
|
269
|
+
rescue KoronaEntryClient::ApiError => e
|
270
|
+
puts "Exception when calling TicketsApi->get_image: #{e}"
|
271
|
+
end
|
272
|
+
```
|
273
|
+
|
274
|
+
### Parameters
|
275
|
+
|
276
|
+
|
277
|
+
Name | Type | Description | Notes
|
278
|
+
------------- | ------------- | ------------- | -------------
|
279
|
+
**client** | **String**| Identification of executing client. |
|
280
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
281
|
+
|
282
|
+
### Return type
|
283
|
+
|
284
|
+
[**TicketImage**](TicketImage.md)
|
285
|
+
|
286
|
+
### Authorization
|
287
|
+
|
288
|
+
[basicAuth](../README.md#basicAuth)
|
289
|
+
|
290
|
+
### HTTP request headers
|
291
|
+
|
292
|
+
- **Content-Type**: Not defined
|
293
|
+
- **Accept**: application/json
|
294
|
+
|
295
|
+
|
296
|
+
## get_logs
|
297
|
+
|
298
|
+
> TicketEntryLogList get_logs(client, time_from, time_to, log_types, opts)
|
299
|
+
|
300
|
+
Returns the log for a optional single ticket and/or organizational unit
|
301
|
+
|
302
|
+
### Example
|
303
|
+
|
304
|
+
```ruby
|
305
|
+
# load the gem
|
306
|
+
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
|
+
|
314
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
315
|
+
client = 'client_example' # String | Identification of executing client.
|
316
|
+
time_from = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Log time from.
|
317
|
+
time_to = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Log time to.
|
318
|
+
log_types = ['log_types_example'] # Array<String> | Restrict the logs to specific log events.
|
319
|
+
opts = {
|
320
|
+
ticket_number: 'ticket_number_example', # String | Optional filter to restrict the logs to actions to the specified ticket.
|
321
|
+
organizational_unit_number: 'organizational_unit_number_example' # String | Optional filter to restrict the logs to actions within the specified organizational unit.
|
322
|
+
}
|
323
|
+
|
324
|
+
begin
|
325
|
+
#Returns the log for a optional single ticket and/or organizational unit
|
326
|
+
result = api_instance.get_logs(client, time_from, time_to, log_types, opts)
|
327
|
+
p result
|
328
|
+
rescue KoronaEntryClient::ApiError => e
|
329
|
+
puts "Exception when calling TicketsApi->get_logs: #{e}"
|
330
|
+
end
|
331
|
+
```
|
332
|
+
|
333
|
+
### Parameters
|
334
|
+
|
335
|
+
|
336
|
+
Name | Type | Description | Notes
|
337
|
+
------------- | ------------- | ------------- | -------------
|
338
|
+
**client** | **String**| Identification of executing client. |
|
339
|
+
**time_from** | **DateTime**| Log time from. |
|
340
|
+
**time_to** | **DateTime**| Log time to. |
|
341
|
+
**log_types** | [**Array<String>**](String.md)| Restrict the logs to specific log events. |
|
342
|
+
**ticket_number** | **String**| Optional filter to restrict the logs to actions to the specified ticket. | [optional]
|
343
|
+
**organizational_unit_number** | **String**| Optional filter to restrict the logs to actions within the specified organizational unit. | [optional]
|
344
|
+
|
345
|
+
### Return type
|
346
|
+
|
347
|
+
[**TicketEntryLogList**](TicketEntryLogList.md)
|
348
|
+
|
349
|
+
### Authorization
|
350
|
+
|
351
|
+
[basicAuth](../README.md#basicAuth)
|
352
|
+
|
353
|
+
### HTTP request headers
|
354
|
+
|
355
|
+
- **Content-Type**: Not defined
|
356
|
+
- **Accept**: application/json
|
357
|
+
|
358
|
+
|
359
|
+
## get_ticket
|
360
|
+
|
361
|
+
> Ticket get_ticket(client, ticket_id)
|
362
|
+
|
363
|
+
Returns the single ticket.
|
364
|
+
|
365
|
+
### Example
|
366
|
+
|
367
|
+
```ruby
|
368
|
+
# load the gem
|
369
|
+
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
|
+
|
377
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
378
|
+
client = 'client_example' # String | Identification of executing client.
|
379
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
380
|
+
|
381
|
+
begin
|
382
|
+
#Returns the single ticket.
|
383
|
+
result = api_instance.get_ticket(client, ticket_id)
|
384
|
+
p result
|
385
|
+
rescue KoronaEntryClient::ApiError => e
|
386
|
+
puts "Exception when calling TicketsApi->get_ticket: #{e}"
|
387
|
+
end
|
388
|
+
```
|
389
|
+
|
390
|
+
### Parameters
|
391
|
+
|
392
|
+
|
393
|
+
Name | Type | Description | Notes
|
394
|
+
------------- | ------------- | ------------- | -------------
|
395
|
+
**client** | **String**| Identification of executing client. |
|
396
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
397
|
+
|
398
|
+
### Return type
|
399
|
+
|
400
|
+
[**Ticket**](Ticket.md)
|
401
|
+
|
402
|
+
### Authorization
|
403
|
+
|
404
|
+
[basicAuth](../README.md#basicAuth)
|
405
|
+
|
406
|
+
### HTTP request headers
|
407
|
+
|
408
|
+
- **Content-Type**: Not defined
|
409
|
+
- **Accept**: application/json
|
410
|
+
|
411
|
+
|
412
|
+
## get_ticket_entry
|
413
|
+
|
414
|
+
> TicketEntry get_ticket_entry(client, ticket_id, ticket_entry_id)
|
415
|
+
|
416
|
+
Returns a single ticket entry.
|
417
|
+
|
418
|
+
### Example
|
419
|
+
|
420
|
+
```ruby
|
421
|
+
# load the gem
|
422
|
+
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
|
+
|
430
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
431
|
+
client = 'client_example' # String | Identification of executing client.
|
432
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
433
|
+
ticket_entry_id = 56 # Integer | ID to identify the ticket entry of the ticket.
|
434
|
+
|
435
|
+
begin
|
436
|
+
#Returns a single ticket entry.
|
437
|
+
result = api_instance.get_ticket_entry(client, ticket_id, ticket_entry_id)
|
438
|
+
p result
|
439
|
+
rescue KoronaEntryClient::ApiError => e
|
440
|
+
puts "Exception when calling TicketsApi->get_ticket_entry: #{e}"
|
441
|
+
end
|
442
|
+
```
|
443
|
+
|
444
|
+
### Parameters
|
445
|
+
|
446
|
+
|
447
|
+
Name | Type | Description | Notes
|
448
|
+
------------- | ------------- | ------------- | -------------
|
449
|
+
**client** | **String**| Identification of executing client. |
|
450
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
451
|
+
**ticket_entry_id** | **Integer**| ID to identify the ticket entry of the ticket. |
|
452
|
+
|
453
|
+
### Return type
|
454
|
+
|
455
|
+
[**TicketEntry**](TicketEntry.md)
|
456
|
+
|
457
|
+
### Authorization
|
458
|
+
|
459
|
+
[basicAuth](../README.md#basicAuth)
|
460
|
+
|
461
|
+
### HTTP request headers
|
462
|
+
|
463
|
+
- **Content-Type**: Not defined
|
464
|
+
- **Accept**: application/json
|
465
|
+
|
466
|
+
|
467
|
+
## get_tickets
|
468
|
+
|
469
|
+
> TicketList get_tickets(client, offset, page_size, opts)
|
470
|
+
|
471
|
+
Lists all tickets.
|
472
|
+
|
473
|
+
### Example
|
474
|
+
|
475
|
+
```ruby
|
476
|
+
# load the gem
|
477
|
+
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
|
+
|
485
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
486
|
+
client = 'client_example' # String | Identification of executing client.
|
487
|
+
offset = 56 # Integer | Position in the dataset to start to retrieve.
|
488
|
+
page_size = 56 # Integer | Amount of objects to return per page.
|
489
|
+
opts = {
|
490
|
+
ticket_number: 'ticket_number_example', # String | Restrict the list for a specific ticket number
|
491
|
+
create_date_from: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Restrict the list for begin of creation date.
|
492
|
+
create_date_to: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Restrict the list for end of creation date.
|
493
|
+
deactivation_date_from: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Restrict the list for start of deactivation date.
|
494
|
+
deactivation_date_to: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Restrict the list for end of deactivation date.
|
495
|
+
locked: true, # Boolean | Restrict the list for locked tickets.
|
496
|
+
locked_to_date_from: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Restrict the list for for locked tickets.
|
497
|
+
locked_to_date_to: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Restrict the list for for locked tickets.
|
498
|
+
personalization_customer_number: 'personalization_customer_number_example', # String | Restrict the list for tickets owned by customers with specific customer number.
|
499
|
+
personalization_lastname: 'personalization_lastname_example', # String | Restrict the list for tickets owned by customers with specific last name.
|
500
|
+
personalization_firstname: 'personalization_firstname_example' # String | Restrict the list for tickets owned by customers with specific first name.
|
501
|
+
}
|
502
|
+
|
503
|
+
begin
|
504
|
+
#Lists all tickets.
|
505
|
+
result = api_instance.get_tickets(client, offset, page_size, opts)
|
506
|
+
p result
|
507
|
+
rescue KoronaEntryClient::ApiError => e
|
508
|
+
puts "Exception when calling TicketsApi->get_tickets: #{e}"
|
509
|
+
end
|
510
|
+
```
|
511
|
+
|
512
|
+
### Parameters
|
513
|
+
|
514
|
+
|
515
|
+
Name | Type | Description | Notes
|
516
|
+
------------- | ------------- | ------------- | -------------
|
517
|
+
**client** | **String**| Identification of executing client. |
|
518
|
+
**offset** | **Integer**| Position in the dataset to start to retrieve. |
|
519
|
+
**page_size** | **Integer**| Amount of objects to return per page. |
|
520
|
+
**ticket_number** | **String**| Restrict the list for a specific ticket number | [optional]
|
521
|
+
**create_date_from** | **DateTime**| Restrict the list for begin of creation date. | [optional]
|
522
|
+
**create_date_to** | **DateTime**| Restrict the list for end of creation date. | [optional]
|
523
|
+
**deactivation_date_from** | **DateTime**| Restrict the list for start of deactivation date. | [optional]
|
524
|
+
**deactivation_date_to** | **DateTime**| Restrict the list for end of deactivation date. | [optional]
|
525
|
+
**locked** | **Boolean**| Restrict the list for locked tickets. | [optional]
|
526
|
+
**locked_to_date_from** | **DateTime**| Restrict the list for for locked tickets. | [optional]
|
527
|
+
**locked_to_date_to** | **DateTime**| Restrict the list for for locked tickets. | [optional]
|
528
|
+
**personalization_customer_number** | **String**| Restrict the list for tickets owned by customers with specific customer number. | [optional]
|
529
|
+
**personalization_lastname** | **String**| Restrict the list for tickets owned by customers with specific last name. | [optional]
|
530
|
+
**personalization_firstname** | **String**| Restrict the list for tickets owned by customers with specific first name. | [optional]
|
531
|
+
|
532
|
+
### Return type
|
533
|
+
|
534
|
+
[**TicketList**](TicketList.md)
|
535
|
+
|
536
|
+
### Authorization
|
537
|
+
|
538
|
+
[basicAuth](../README.md#basicAuth)
|
539
|
+
|
540
|
+
### HTTP request headers
|
541
|
+
|
542
|
+
- **Content-Type**: Not defined
|
543
|
+
- **Accept**: application/json
|
544
|
+
|
545
|
+
|
546
|
+
## update_image
|
547
|
+
|
548
|
+
> ModelReference update_image(client, ticket_id, body)
|
549
|
+
|
550
|
+
Updates the owners image of the ticket
|
551
|
+
|
552
|
+
### Example
|
553
|
+
|
554
|
+
```ruby
|
555
|
+
# load the gem
|
556
|
+
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
|
+
|
564
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
565
|
+
client = 'client_example' # String | Identification of executing client.
|
566
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
567
|
+
body = KoronaEntryClient::TicketImage.new # TicketImage | Properties to update of the image.
|
568
|
+
|
569
|
+
begin
|
570
|
+
#Updates the owners image of the ticket
|
571
|
+
result = api_instance.update_image(client, ticket_id, body)
|
572
|
+
p result
|
573
|
+
rescue KoronaEntryClient::ApiError => e
|
574
|
+
puts "Exception when calling TicketsApi->update_image: #{e}"
|
575
|
+
end
|
576
|
+
```
|
577
|
+
|
578
|
+
### Parameters
|
579
|
+
|
580
|
+
|
581
|
+
Name | Type | Description | Notes
|
582
|
+
------------- | ------------- | ------------- | -------------
|
583
|
+
**client** | **String**| Identification of executing client. |
|
584
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
585
|
+
**body** | [**TicketImage**](TicketImage.md)| Properties to update of the image. |
|
586
|
+
|
587
|
+
### Return type
|
588
|
+
|
589
|
+
[**ModelReference**](ModelReference.md)
|
590
|
+
|
591
|
+
### Authorization
|
592
|
+
|
593
|
+
[basicAuth](../README.md#basicAuth)
|
594
|
+
|
595
|
+
### HTTP request headers
|
596
|
+
|
597
|
+
- **Content-Type**: application/json
|
598
|
+
- **Accept**: application/json
|
599
|
+
|
600
|
+
|
601
|
+
## update_ticket
|
602
|
+
|
603
|
+
> ModelReference update_ticket(client, ticket_id, body)
|
604
|
+
|
605
|
+
Updates the single ticket.
|
606
|
+
|
607
|
+
### Example
|
608
|
+
|
609
|
+
```ruby
|
610
|
+
# load the gem
|
611
|
+
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
|
+
|
619
|
+
api_instance = KoronaEntryClient::TicketsApi.new
|
620
|
+
client = 'client_example' # String | Identification of executing client.
|
621
|
+
ticket_id = 56 # Integer | ID to identify the ticket.
|
622
|
+
body = KoronaEntryClient::Ticket.new # Ticket | Properties to update of the ticket.
|
623
|
+
|
624
|
+
begin
|
625
|
+
#Updates the single ticket.
|
626
|
+
result = api_instance.update_ticket(client, ticket_id, body)
|
627
|
+
p result
|
628
|
+
rescue KoronaEntryClient::ApiError => e
|
629
|
+
puts "Exception when calling TicketsApi->update_ticket: #{e}"
|
630
|
+
end
|
631
|
+
```
|
632
|
+
|
633
|
+
### Parameters
|
634
|
+
|
635
|
+
|
636
|
+
Name | Type | Description | Notes
|
637
|
+
------------- | ------------- | ------------- | -------------
|
638
|
+
**client** | **String**| Identification of executing client. |
|
639
|
+
**ticket_id** | **Integer**| ID to identify the ticket. |
|
640
|
+
**body** | [**Ticket**](Ticket.md)| Properties to update of the ticket. |
|
641
|
+
|
642
|
+
### Return type
|
643
|
+
|
644
|
+
[**ModelReference**](ModelReference.md)
|
645
|
+
|
646
|
+
### Authorization
|
647
|
+
|
648
|
+
[basicAuth](../README.md#basicAuth)
|
649
|
+
|
650
|
+
### HTTP request headers
|
651
|
+
|
652
|
+
- **Content-Type**: application/json
|
653
|
+
- **Accept**: application/json
|
654
|
+
|