Class: KoronaClient::TicketingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona_client/api/ticketing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TicketingApi

Returns a new instance of TicketingApi.



19
20
21
 
# File 'lib/korona_client/api/ticketing_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/korona_client/api/ticketing_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_events(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new events

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of new events

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



29
30
31
32
 
# File 'lib/korona_client/api/ticketing_api.rb', line 29

def add_events(, body, opts = {})
  data, _status_code, _headers = add_events_with_http_info(, body, opts)
  data
end

#add_events_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds a batch of new events

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of new events

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>) —

    Array<AddOrUpdateResult> data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/korona_client/api/ticketing_api.rb', line 41

def add_events_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.add_events ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.add_events"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.add_events"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/events'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#add_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_or_update_attendances(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates/adds attendances

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of attendances

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



91
92
93
94
 
# File 'lib/korona_client/api/ticketing_api.rb', line 91

def add_or_update_attendances(, body, opts = {})
  data, _status_code, _headers = add_or_update_attendances_with_http_info(, body, opts)
  data
end

#add_or_update_attendances_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

updates/adds attendances

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of attendances

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>) —

    Array<AddOrUpdateResult> data, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/korona_client/api/ticketing_api.rb', line 102

def add_or_update_attendances_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.add_or_update_attendances ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.add_or_update_attendances"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.add_or_update_attendances"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/attendance'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#add_or_update_attendances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_ticket_definitions(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new ticket definitions

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:



152
153
154
155
 
# File 'lib/korona_client/api/ticketing_api.rb', line 152

def add_ticket_definitions(, body, opts = {})
  data, _status_code, _headers = add_ticket_definitions_with_http_info(, body, opts)
  data
end

#add_ticket_definitions_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

adds a batch of new ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of new ticket definitions

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :upsert (BOOLEAN) —

    when set to true, updates the object instead of generating a already-exists-error

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>) —

    Array<AddOrUpdateResult> data, response status code and response headers



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/korona_client/api/ticketing_api.rb', line 164

def add_ticket_definitions_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.add_ticket_definitions ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.add_ticket_definitions"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.add_ticket_definitions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketDefinitions'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#add_ticket_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cancel_attendance(korona_account_id, attendance_id, opts = {}) ⇒ nil

cancel the attendance

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • attendance_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


214
215
216
217
 
# File 'lib/korona_client/api/ticketing_api.rb', line 214

def cancel_attendance(, attendance_id, opts = {})
  cancel_attendance_with_http_info(, attendance_id, opts)
  nil
end

#cancel_attendance_with_http_info(korona_account_id, attendance_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

cancel the attendance

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • attendance_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/korona_client/api/ticketing_api.rb', line 225

def cancel_attendance_with_http_info(, attendance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.cancel_attendance ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.cancel_attendance"
  end
  # verify the required parameter 'attendance_id' is set
  if @api_client.config.client_side_validation && attendance_id.nil?
    fail ArgumentError, "Missing the required parameter 'attendance_id' when calling TicketingApi.cancel_attendance"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/attendance/{attendanceId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'attendanceId' + '}', attendance_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#cancel_attendance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_event(korona_account_id, event_id, opts = {}) ⇒ nil

deletes the single event

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • event_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


273
274
275
276
 
# File 'lib/korona_client/api/ticketing_api.rb', line 273

def delete_event(, event_id, opts = {})
  delete_event_with_http_info(, event_id, opts)
  nil
end

#delete_event_with_http_info(korona_account_id, event_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

deletes the single event

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • event_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/korona_client/api/ticketing_api.rb', line 284

def delete_event_with_http_info(, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.delete_event ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.delete_event"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling TicketingApi.delete_event"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/events/{eventId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'eventId' + '}', event_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#delete_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ticket_definition(korona_account_id, ticket_definition_id, opts = {}) ⇒ nil

deletes the single ticket definition

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_definition_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


332
333
334
335
 
# File 'lib/korona_client/api/ticketing_api.rb', line 332

def delete_ticket_definition(, ticket_definition_id, opts = {})
  delete_ticket_definition_with_http_info(, ticket_definition_id, opts)
  nil
end

#delete_ticket_definition_with_http_info(korona_account_id, ticket_definition_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

deletes the single ticket definition

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_definition_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/korona_client/api/ticketing_api.rb', line 343

def delete_ticket_definition_with_http_info(, ticket_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.delete_ticket_definition ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.delete_ticket_definition"
  end
  # verify the required parameter 'ticket_definition_id' is set
  if @api_client.config.client_side_validation && ticket_definition_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_definition_id' when calling TicketingApi.delete_ticket_definition"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketDefinitions/{ticketDefinitionId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'ticketDefinitionId' + '}', ticket_definition_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#delete_ticket_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_ticket_definitions(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing ticket definitions (id or number required)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/korona_client/api/ticketing_api.rb', line 391

def delete_ticket_definitions(, body, opts = {})
  data, _status_code, _headers = delete_ticket_definitions_with_http_info(, body, opts)
  data
end

#delete_ticket_definitions_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

deletes a batch of ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing ticket definitions (id or number required)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>) —

    Array<AddOrUpdateResult> data, response status code and response headers



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/korona_client/api/ticketing_api.rb', line 402

def delete_ticket_definitions_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.delete_ticket_definitions ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.delete_ticket_definitions"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.delete_ticket_definitions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketDefinitions'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#delete_ticket_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_attendances(korona_account_id, opts = {}) ⇒ ResultListAttendance

lists all attendances

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



455
456
457
458
 
# File 'lib/korona_client/api/ticketing_api.rb', line 455

def get_attendances(, opts = {})
  data, _status_code, _headers = get_attendances_with_http_info(, opts)
  data
end

#get_attendances_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListAttendance, Fixnum, Hash)>

lists all attendances

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:

  • (Array<(ResultListAttendance, Fixnum, Hash)>) —

    ResultListAttendance data, response status code and response headers



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/korona_client/api/ticketing_api.rb', line 470

def get_attendances_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_attendances ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_attendances"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/attendance'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListAttendance')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_attendances\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_entry_gate(korona_account_id, entry_gate_id, opts = {}) ⇒ EntryGate

returns the single entry gate

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • entry_gate_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



520
521
522
523
 
# File 'lib/korona_client/api/ticketing_api.rb', line 520

def get_entry_gate(, entry_gate_id, opts = {})
  data, _status_code, _headers = get_entry_gate_with_http_info(, entry_gate_id, opts)
  data
end

#get_entry_gate_with_http_info(korona_account_id, entry_gate_id, opts = {}) ⇒ Array<(EntryGate, Fixnum, Hash)>

returns the single entry gate

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • entry_gate_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(EntryGate, Fixnum, Hash)>) —

    EntryGate data, response status code and response headers



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/korona_client/api/ticketing_api.rb', line 531

def get_entry_gate_with_http_info(, entry_gate_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_entry_gate ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_entry_gate"
  end
  # verify the required parameter 'entry_gate_id' is set
  if @api_client.config.client_side_validation && entry_gate_id.nil?
    fail ArgumentError, "Missing the required parameter 'entry_gate_id' when calling TicketingApi.get_entry_gate"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/entryGates/{entryGateId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'entryGateId' + '}', entry_gate_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'EntryGate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_entry_gate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_entry_gates(korona_account_id, opts = {}) ⇒ ResultListEntryGate

lists all entry gates

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:



585
586
587
588
 
# File 'lib/korona_client/api/ticketing_api.rb', line 585

def get_entry_gates(, opts = {})
  data, _status_code, _headers = get_entry_gates_with_http_info(, opts)
  data
end

#get_entry_gates_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListEntryGate, Fixnum, Hash)>

lists all entry gates

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

  • :number (String) —

    number of the related object

Returns:

  • (Array<(ResultListEntryGate, Fixnum, Hash)>) —

    ResultListEntryGate data, response status code and response headers



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
 
# File 'lib/korona_client/api/ticketing_api.rb', line 601

def get_entry_gates_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_entry_gates ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_entry_gates"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/entryGates'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListEntryGate')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_entry_gates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_event(korona_account_id, event_id, opts = {}) ⇒ Event

returns the single event

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • event_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



652
653
654
655
 
# File 'lib/korona_client/api/ticketing_api.rb', line 652

def get_event(, event_id, opts = {})
  data, _status_code, _headers = get_event_with_http_info(, event_id, opts)
  data
end

#get_event_with_http_info(korona_account_id, event_id, opts = {}) ⇒ Array<(Event, Fixnum, Hash)>

returns the single event

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • event_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Event, Fixnum, Hash)>) —

    Event data, response status code and response headers



663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/korona_client/api/ticketing_api.rb', line 663

def get_event_with_http_info(, event_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_event ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_event"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling TicketingApi.get_event"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/events/{eventId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'eventId' + '}', event_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Event')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_events(korona_account_id, opts = {}) ⇒ ResultListEvent

lists all events

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



716
717
718
719
 
# File 'lib/korona_client/api/ticketing_api.rb', line 716

def get_events(, opts = {})
  data, _status_code, _headers = get_events_with_http_info(, opts)
  data
end

#get_events_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListEvent, Fixnum, Hash)>

lists all events

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:

  • (Array<(ResultListEvent, Fixnum, Hash)>) —

    ResultListEvent data, response status code and response headers



731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'lib/korona_client/api/ticketing_api.rb', line 731

def get_events_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_events ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_events"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/events'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListEvent')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ticket_definition(korona_account_id, ticket_definition_id, opts = {}) ⇒ TicketDefinition

returns the single ticket definition

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_definition_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



781
782
783
784
 
# File 'lib/korona_client/api/ticketing_api.rb', line 781

def get_ticket_definition(, ticket_definition_id, opts = {})
  data, _status_code, _headers = get_ticket_definition_with_http_info(, ticket_definition_id, opts)
  data
end

#get_ticket_definition_with_http_info(korona_account_id, ticket_definition_id, opts = {}) ⇒ Array<(TicketDefinition, Fixnum, Hash)>

returns the single ticket definition

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_definition_id —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(TicketDefinition, Fixnum, Hash)>) —

    TicketDefinition data, response status code and response headers



792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
 
# File 'lib/korona_client/api/ticketing_api.rb', line 792

def get_ticket_definition_with_http_info(, ticket_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_ticket_definition ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_ticket_definition"
  end
  # verify the required parameter 'ticket_definition_id' is set
  if @api_client.config.client_side_validation && ticket_definition_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_definition_id' when calling TicketingApi.get_ticket_definition"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketDefinitions/{ticketDefinitionId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'ticketDefinitionId' + '}', ticket_definition_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TicketDefinition')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_ticket_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ticket_definitions(korona_account_id, opts = {}) ⇒ ResultListTicketDefinition

lists all ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:



845
846
847
848
 
# File 'lib/korona_client/api/ticketing_api.rb', line 845

def get_ticket_definitions(, opts = {})
  data, _status_code, _headers = get_ticket_definitions_with_http_info(, opts)
  data
end

#get_ticket_definitions_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListTicketDefinition, Fixnum, Hash)>

lists all ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

    attribute to sort by (multiple separated by comma; max. 5)

  • :revision (Integer) —

    last revision number, objects with a greater revision than this will be returned

  • :include_deleted (BOOLEAN) —

    indicates deleted objects should be loaded or not (default: false)

Returns:

  • (Array<(ResultListTicketDefinition, Fixnum, Hash)>) —

    ResultListTicketDefinition data, response status code and response headers



860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
 
# File 'lib/korona_client/api/ticketing_api.rb', line 860

def get_ticket_definitions_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_ticket_definitions ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_ticket_definitions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketDefinitions'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].nil?
  query_params[:'includeDeleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListTicketDefinition')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_ticket_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_tickets(korona_account_id, page, size, opts = {}) ⇒ ResultListTicket

lists all tickets

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • page —

    number of the page to fetch

  • size —

    amount of objects to return per page

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ticket_number (String) —

    ticket number

  • :customer_number (String) —

    customer number

  • :creation_date_from (DateTime) —

    creation date from

  • :creation_date_to (DateTime) —

    creation date to

  • :locked (BOOLEAN) —

    is ticket locked

  • :owner_last_name (String) —

    last name of owner

  • :owner_first_name (String) —

    first name of owner

  • :load_owner_image (BOOLEAN) —

    set true if you want to load the owner&#39;s image

Returns:



919
920
921
922
 
# File 'lib/korona_client/api/ticketing_api.rb', line 919

def get_tickets(, page, size, opts = {})
  data, _status_code, _headers = get_tickets_with_http_info(, page, size, opts)
  data
end

#get_tickets_with_http_info(korona_account_id, page, size, opts = {}) ⇒ Array<(ResultListTicket, Fixnum, Hash)>

lists all tickets

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • page —

    number of the page to fetch

  • size —

    amount of objects to return per page

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ticket_number (String) —

    ticket number

  • :customer_number (String) —

    customer number

  • :creation_date_from (DateTime) —

    creation date from

  • :creation_date_to (DateTime) —

    creation date to

  • :locked (BOOLEAN) —

    is ticket locked

  • :owner_last_name (String) —

    last name of owner

  • :owner_first_name (String) —

    first name of owner

  • :load_owner_image (BOOLEAN) —

    set true if you want to load the owner&#39;s image

Returns:

  • (Array<(ResultListTicket, Fixnum, Hash)>) —

    ResultListTicket data, response status code and response headers



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/korona_client/api/ticketing_api.rb', line 939

def get_tickets_with_http_info(, page, size, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.get_tickets ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.get_tickets"
  end
  # verify the required parameter 'page' is set
  if @api_client.config.client_side_validation && page.nil?
    fail ArgumentError, "Missing the required parameter 'page' when calling TicketingApi.get_tickets"
  end
  # verify the required parameter 'size' is set
  if @api_client.config.client_side_validation && size.nil?
    fail ArgumentError, "Missing the required parameter 'size' when calling TicketingApi.get_tickets"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tickets'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'page'] = page
  query_params[:'size'] = size
  query_params[:'ticketNumber'] = opts[:'ticket_number'] if !opts[:'ticket_number'].nil?
  query_params[:'customerNumber'] = opts[:'customer_number'] if !opts[:'customer_number'].nil?
  query_params[:'creationDateFrom'] = opts[:'creation_date_from'] if !opts[:'creation_date_from'].nil?
  query_params[:'creationDateTo'] = opts[:'creation_date_to'] if !opts[:'creation_date_to'].nil?
  query_params[:'locked'] = opts[:'locked'] if !opts[:'locked'].nil?
  query_params[:'ownerLastName'] = opts[:'owner_last_name'] if !opts[:'owner_last_name'].nil?
  query_params[:'ownerFirstName'] = opts[:'owner_first_name'] if !opts[:'owner_first_name'].nil?
  query_params[:'loadOwnerImage'] = opts[:'load_owner_image'] if !opts[:'load_owner_image'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ResultListTicket')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#get_tickets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#lock_ticket(korona_account_id, ticket_number, opts = {}) ⇒ nil

locks the single ticket

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_number —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1002
1003
1004
1005
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1002

def lock_ticket(, ticket_number, opts = {})
  lock_ticket_with_http_info(, ticket_number, opts)
  nil
end

#lock_ticket_with_http_info(korona_account_id, ticket_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

locks the single ticket

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_number —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1013

def lock_ticket_with_http_info(, ticket_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.lock_ticket ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.lock_ticket"
  end
  # verify the required parameter 'ticket_number' is set
  if @api_client.config.client_side_validation && ticket_number.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_number' when calling TicketingApi.lock_ticket"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tickets/{ticketNumber}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'ticketNumber' + '}', ticket_number.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#lock_ticket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unlock_ticket(korona_account_id, ticket_number, opts = {}) ⇒ nil

unlocks the single ticket

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_number —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1061
1062
1063
1064
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1061

def unlock_ticket(, ticket_number, opts = {})
  unlock_ticket_with_http_info(, ticket_number, opts)
  nil
end

#unlock_ticket_with_http_info(korona_account_id, ticket_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

unlocks the single ticket

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_number —

    id of the related object (important: id should match the uuid-format)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1072

def unlock_ticket_with_http_info(, ticket_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.unlock_ticket ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.unlock_ticket"
  end
  # verify the required parameter 'ticket_number' is set
  if @api_client.config.client_side_validation && ticket_number.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_number' when calling TicketingApi.unlock_ticket"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tickets/{ticketNumber}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'ticketNumber' + '}', ticket_number.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#unlock_ticket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_event(korona_account_id, event_id, body, opts = {}) ⇒ nil

updates the single event

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • event_id —

    id of the related object (important: id should match the uuid-format)

  • body —

    the properties to update of the event

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1121
1122
1123
1124
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1121

def update_event(, event_id, body, opts = {})
  update_event_with_http_info(, event_id, body, opts)
  nil
end

#update_event_with_http_info(korona_account_id, event_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the single event

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • event_id —

    id of the related object (important: id should match the uuid-format)

  • body —

    the properties to update of the event

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1133

def update_event_with_http_info(, event_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.update_event ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.update_event"
  end
  # verify the required parameter 'event_id' is set
  if @api_client.config.client_side_validation && event_id.nil?
    fail ArgumentError, "Missing the required parameter 'event_id' when calling TicketingApi.update_event"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.update_event"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/events/{eventId}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'eventId' + '}', event_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#update_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_events(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of events

number

must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of existing events

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1185
1186
1187
1188
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1185

def update_events(, body, opts = {})
  data, _status_code, _headers = update_events_with_http_info(, body, opts)
  data
end

#update_events_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

updates a batch of events

number

must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    an array of existing events

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>) —

    Array<AddOrUpdateResult> data, response status code and response headers



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1196

def update_events_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.update_events ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.update_events"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.update_events"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/events'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#update_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_ticket(korona_account_id, ticket_number, opts = {}) ⇒ nil

updates the single ticket

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_number —

    old ticket number

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :new_ticket_number (String) —

    new ticket number

  • :first_name (String) —

    ticket owner&#39;s first name

  • :last_name (String) —

    ticket owner&#39;s last name

Returns:

  • (nil) 


1248
1249
1250
1251
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1248

def update_ticket(, ticket_number, opts = {})
  update_ticket_with_http_info(, ticket_number, opts)
  nil
end

#update_ticket_definitions(korona_account_id, body, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing ticket definitions (id or number required)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1313
1314
1315
1316
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1313

def update_ticket_definitions(, body, opts = {})
  data, _status_code, _headers = update_ticket_definitions_with_http_info(, body, opts)
  data
end

#update_ticket_definitions_with_http_info(korona_account_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>

updates a batch of ticket definitions

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • body —

    array of existing ticket definitions (id or number required)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<AddOrUpdateResult>, Fixnum, Hash)>) —

    Array<AddOrUpdateResult> data, response status code and response headers



1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1324

def update_ticket_definitions_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.update_ticket_definitions ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.update_ticket_definitions"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling TicketingApi.update_ticket_definitions"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/ticketDefinitions'.sub('{' + 'koronaAccountId' + '}', .to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<AddOrUpdateResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#update_ticket_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_ticket_with_http_info(korona_account_id, ticket_number, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

updates the single ticket

Parameters:

  • korona_account_id —

    account id of the KORONA.cloud account

  • ticket_number —

    old ticket number

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :new_ticket_number (String) —

    new ticket number

  • :first_name (String) —

    ticket owner&#39;s first name

  • :last_name (String) —

    ticket owner&#39;s last name

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
 
# File 'lib/korona_client/api/ticketing_api.rb', line 1262

def update_ticket_with_http_info(, ticket_number, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TicketingApi.update_ticket ...'
  end
  # verify the required parameter 'korona_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'korona_account_id' when calling TicketingApi.update_ticket"
  end
  # verify the required parameter 'ticket_number' is set
  if @api_client.config.client_side_validation && ticket_number.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_number' when calling TicketingApi.update_ticket"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/tickets/{ticketNumber}'.sub('{' + 'koronaAccountId' + '}', .to_s).sub('{' + 'ticketNumber' + '}', ticket_number.to_s)

  # query parameters
  query_params = {}
  query_params[:'newTicketNumber'] = opts[:'new_ticket_number'] if !opts[:'new_ticket_number'].nil?
  query_params[:'firstName'] = opts[:'first_name'] if !opts[:'first_name'].nil?
  query_params[:'lastName'] = opts[:'last_name'] if !opts[:'last_name'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TicketingApi#update_ticket\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end