Class: KoronaCloudClient::DispatchNotificationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/korona-cloud-client/api/dispatch_notifications_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DispatchNotificationsApi

Returns a new instance of DispatchNotificationsApi.



19
20
21
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_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-cloud-client/api/dispatch_notifications_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

adds dispatch notification items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • body (Array<DispatchNotificationItem>) —

    array of new dispatch notification items

  • 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-cloud-client/api/dispatch_notifications_api.rb', line 29

def add_dispatch_notification_items(, dispatch_notification_id, body, opts = {})
  data, _status_code, _headers = add_dispatch_notification_items_with_http_info(, dispatch_notification_id, body, opts)
  data
end

#add_dispatch_notification_items_with_http_info(korona_account_id, dispatch_notification_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds dispatch notification items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • body (Array<DispatchNotificationItem>) —

    array of new dispatch notification items

  • 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>, Integer, 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 41

def add_dispatch_notification_items_with_http_info(, dispatch_notification_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.add_dispatch_notification_items ...'
  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 DispatchNotificationsApi.add_dispatch_notification_items"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.add_dispatch_notification_items"
  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 DispatchNotificationsApi.add_dispatch_notification_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.add_dispatch_notification_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#add_dispatch_notification_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

adds dispatch notifications

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<DispatchNotification>) —

    array of new dispatch notifications

  • 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:



109
110
111
112
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 109

def add_dispatch_notifications(, body, opts = {})
  data, _status_code, _headers = add_dispatch_notifications_with_http_info(, body, opts)
  data
end

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

adds dispatch notifications

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • body (Array<DispatchNotification>) —

    array of new dispatch notifications

  • 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>, Integer, Hash)>) —

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



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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 120

def add_dispatch_notifications_with_http_info(, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.add_dispatch_notifications ...'
  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 DispatchNotificationsApi.add_dispatch_notifications"
  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 DispatchNotificationsApi.add_dispatch_notifications"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.add_dispatch_notifications",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#add_dispatch_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#book_dispatch_notification(korona_account_id, dispatch_notification_id, opts = {}) ⇒ nil

books the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


183
184
185
186
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 183

def book_dispatch_notification(, dispatch_notification_id, opts = {})
  book_dispatch_notification_with_http_info(, dispatch_notification_id, opts)
  nil
end

#book_dispatch_notification_with_http_info(korona_account_id, dispatch_notification_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

books the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 193

def book_dispatch_notification_with_http_info(, dispatch_notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.book_dispatch_notification ...'
  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 DispatchNotificationsApi.book_dispatch_notification"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.book_dispatch_notification"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/book'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.book_dispatch_notification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#book_dispatch_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dispatch_notification(korona_account_id, dispatch_notification_id, opts = {}) ⇒ nil

deletes the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


250
251
252
253
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 250

def delete_dispatch_notification(, dispatch_notification_id, opts = {})
  delete_dispatch_notification_with_http_info(, dispatch_notification_id, opts)
  nil
end

#delete_dispatch_notification_item(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, opts = {}) ⇒ nil

deletes the single dispatch notification item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • dispatch_notification_item_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


318
319
320
321
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 318

def delete_dispatch_notification_item(, dispatch_notification_id, dispatch_notification_item_id, opts = {})
  delete_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, opts)
  nil
end

#delete_dispatch_notification_item_with_http_info(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single dispatch notification item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • dispatch_notification_item_id (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



329
330
331
332
333
334
335
336
337
338
339
340
341
342
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
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 329

def delete_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.delete_dispatch_notification_item ...'
  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 DispatchNotificationsApi.delete_dispatch_notification_item"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.delete_dispatch_notification_item"
  end
  # verify the required parameter 'dispatch_notification_item_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_item_id' when calling DispatchNotificationsApi.delete_dispatch_notification_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/items/{dispatchNotificationItemId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s)).sub('{' + 'dispatchNotificationItemId' + '}', CGI.escape(dispatch_notification_item_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.delete_dispatch_notification_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#delete_dispatch_notification_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dispatch_notification_with_http_info(korona_account_id, dispatch_notification_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 260

def delete_dispatch_notification_with_http_info(, dispatch_notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.delete_dispatch_notification ...'
  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 DispatchNotificationsApi.delete_dispatch_notification"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.delete_dispatch_notification"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.delete_dispatch_notification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#delete_dispatch_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_notification(korona_account_id, dispatch_notification_id, opts = {}) ⇒ DispatchNotification

returns the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

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

    the optional parameters

Returns:



390
391
392
393
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 390

def get_dispatch_notification(, dispatch_notification_id, opts = {})
  data, _status_code, _headers = get_dispatch_notification_with_http_info(, dispatch_notification_id, opts)
  data
end

#get_dispatch_notification_item(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, opts = {}) ⇒ DispatchNotificationItem

returns the single dispatch notification item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • dispatch_notification_item_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :show_import_data (Boolean) —

    when set to true, import data will included in response

Returns:



459
460
461
462
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 459

def get_dispatch_notification_item(, dispatch_notification_id, dispatch_notification_item_id, opts = {})
  data, _status_code, _headers = get_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, opts)
  data
end

#get_dispatch_notification_item_with_http_info(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, opts = {}) ⇒ Array<(DispatchNotificationItem, Integer, Hash)>

returns the single dispatch notification item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • dispatch_notification_item_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :show_import_data (Boolean) —

    when set to true, import data will included in response

Returns:

  • (Array<(DispatchNotificationItem, Integer, Hash)>) —

    DispatchNotificationItem data, response status code and response headers



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
514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 471

def get_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.get_dispatch_notification_item ...'
  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 DispatchNotificationsApi.get_dispatch_notification_item"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.get_dispatch_notification_item"
  end
  # verify the required parameter 'dispatch_notification_item_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_item_id' when calling DispatchNotificationsApi.get_dispatch_notification_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/items/{dispatchNotificationItemId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s)).sub('{' + 'dispatchNotificationItemId' + '}', CGI.escape(dispatch_notification_item_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DispatchNotificationItem'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.get_dispatch_notification_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#get_dispatch_notification_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_notification_items(korona_account_id, dispatch_notification_id, opts = {}) ⇒ ResultListDispatchNotificationItem

lists all dispatch notification items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • 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

  • :show_import_data (Boolean) —

    when set to true, import data will included in response

Returns:



538
539
540
541
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 538

def get_dispatch_notification_items(, dispatch_notification_id, opts = {})
  data, _status_code, _headers = get_dispatch_notification_items_with_http_info(, dispatch_notification_id, opts)
  data
end

#get_dispatch_notification_items_with_http_info(korona_account_id, dispatch_notification_id, opts = {}) ⇒ Array<(ResultListDispatchNotificationItem, Integer, Hash)>

lists all dispatch notification items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • 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

  • :show_import_data (Boolean) —

    when set to true, import data will included in response

Returns:



553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 553

def get_dispatch_notification_items_with_http_info(, dispatch_notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.get_dispatch_notification_items ...'
  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 DispatchNotificationsApi.get_dispatch_notification_items"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.get_dispatch_notification_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

  # query parameters
  query_params = opts[: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[:'showImportData'] = opts[:'show_import_data'] if !opts[:'show_import_data'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResultListDispatchNotificationItem'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.get_dispatch_notification_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#get_dispatch_notification_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_notification_with_http_info(korona_account_id, dispatch_notification_id, opts = {}) ⇒ Array<(DispatchNotification, Integer, Hash)>

returns the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

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

    the optional parameters

Returns:

  • (Array<(DispatchNotification, Integer, Hash)>) —

    DispatchNotification data, response status code and response headers



400
401
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
445
446
447
448
449
450
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 400

def get_dispatch_notification_with_http_info(, dispatch_notification_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.get_dispatch_notification ...'
  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 DispatchNotificationsApi.get_dispatch_notification"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.get_dispatch_notification"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DispatchNotification'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.get_dispatch_notification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#get_dispatch_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_notifications(korona_account_id, opts = {}) ⇒ ResultListDispatchNotification

lists all dispatch notifications

Parameters:

  • korona_account_id (String) —

    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)

  • :min_create_time (Time) —

    min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_create_time (Time) —

    max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :min_booking_time (Time) —

    min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_booking_time (Time) —

    max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :organizational_unit (String) —

    organizational unit

  • :source_organizational_unit (String) —

    source organizational unit

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

  • :number (String) —

    number of the related object

Returns:



627
628
629
630
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 627

def get_dispatch_notifications(, opts = {})
  data, _status_code, _headers = get_dispatch_notifications_with_http_info(, opts)
  data
end

#get_dispatch_notifications_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListDispatchNotification, Integer, Hash)>

lists all dispatch notifications

Parameters:

  • korona_account_id (String) —

    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)

  • :min_create_time (Time) —

    min (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_create_time (Time) —

    max (inclusive) create time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :min_booking_time (Time) —

    min (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :max_booking_time (Time) —

    max (inclusive) booking time of the receipt (ISO 8601; Format: YYYY-MM-DDTHH:MM:SS; timezone optional)

  • :organizational_unit (String) —

    organizational unit

  • :source_organizational_unit (String) —

    source organizational unit

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

  • :number (String) —

    number of the related object

Returns:



649
650
651
652
653
654
655
656
657
658
659
660
661
662
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
706
707
708
709
710
711
712
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 649

def get_dispatch_notifications_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.get_dispatch_notifications ...'
  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 DispatchNotificationsApi.get_dispatch_notifications"
  end
  allowable_values = ["BOOKED", "IN_PROGRESS"]
  if @api_client.config.client_side_validation && opts[:'booking_status'] && !allowable_values.include?(opts[:'booking_status'])
    fail ArgumentError, "invalid value for \"booking_status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[: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[:'minCreateTime'] = opts[:'min_create_time'] if !opts[:'min_create_time'].nil?
  query_params[:'maxCreateTime'] = opts[:'max_create_time'] if !opts[:'max_create_time'].nil?
  query_params[:'minBookingTime'] = opts[:'min_booking_time'] if !opts[:'min_booking_time'].nil?
  query_params[:'maxBookingTime'] = opts[:'max_booking_time'] if !opts[:'max_booking_time'].nil?
  query_params[:'organizationalUnit'] = opts[:'organizational_unit'] if !opts[:'organizational_unit'].nil?
  query_params[:'sourceOrganizationalUnit'] = opts[:'source_organizational_unit'] if !opts[:'source_organizational_unit'].nil?
  query_params[:'bookingStatus'] = opts[:'booking_status'] if !opts[:'booking_status'].nil?
  query_params[:'number'] = opts[:'number'] if !opts[:'number'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ResultListDispatchNotification'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.get_dispatch_notifications",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#get_dispatch_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dispatch_notification(korona_account_id, dispatch_notification_id, body, opts = {}) ⇒ nil

updates the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • body (DispatchNotification) —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


720
721
722
723
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 720

def update_dispatch_notification(, dispatch_notification_id, body, opts = {})
  update_dispatch_notification_with_http_info(, dispatch_notification_id, body, opts)
  nil
end

#update_dispatch_notification_item(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, body, opts = {}) ⇒ nil

updates the single dispatch notification item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • dispatch_notification_item_id (String) —

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

  • body (DispatchNotificationItem) —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


799
800
801
802
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 799

def update_dispatch_notification_item(, dispatch_notification_id, dispatch_notification_item_id, body, opts = {})
  update_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, body, opts)
  nil
end

#update_dispatch_notification_item_with_http_info(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single dispatch notification item

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • dispatch_notification_item_id (String) —

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

  • body (DispatchNotificationItem) —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 811

def update_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.update_dispatch_notification_item ...'
  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 DispatchNotificationsApi.update_dispatch_notification_item"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.update_dispatch_notification_item"
  end
  # verify the required parameter 'dispatch_notification_item_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_item_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_item_id' when calling DispatchNotificationsApi.update_dispatch_notification_item"
  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 DispatchNotificationsApi.update_dispatch_notification_item"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/items/{dispatchNotificationItemId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s)).sub('{' + 'dispatchNotificationItemId' + '}', CGI.escape(dispatch_notification_item_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.update_dispatch_notification_item",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#update_dispatch_notification_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

updates dispatch notification items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • body (Array<DispatchNotificationItem>) —

    data to update

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

    the optional parameters

Returns:



882
883
884
885
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 882

def update_dispatch_notification_items(, dispatch_notification_id, body, opts = {})
  data, _status_code, _headers = update_dispatch_notification_items_with_http_info(, dispatch_notification_id, body, opts)
  data
end

#update_dispatch_notification_items_with_http_info(korona_account_id, dispatch_notification_id, body, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

updates dispatch notification items

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • body (Array<DispatchNotificationItem>) —

    data to update

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

    the optional parameters

Returns:

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

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



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 893

def update_dispatch_notification_items_with_http_info(, dispatch_notification_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.update_dispatch_notification_items ...'
  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 DispatchNotificationsApi.update_dispatch_notification_items"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.update_dispatch_notification_items"
  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 DispatchNotificationsApi.update_dispatch_notification_items"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}/items'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'Array<AddOrUpdateResult>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.update_dispatch_notification_items",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#update_dispatch_notification_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dispatch_notification_with_http_info(korona_account_id, dispatch_notification_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single dispatch notification

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification_id (String) —

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

  • body (DispatchNotification) —

    data to update

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

    the optional parameters

Returns:

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

    nil, 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
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 731

def update_dispatch_notification_with_http_info(, dispatch_notification_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchNotificationsApi.update_dispatch_notification ...'
  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 DispatchNotificationsApi.update_dispatch_notification"
  end
  # verify the required parameter 'dispatch_notification_id' is set
  if @api_client.config.client_side_validation && dispatch_notification_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_id' when calling DispatchNotificationsApi.update_dispatch_notification"
  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 DispatchNotificationsApi.update_dispatch_notification"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/dispatchNotifications/{dispatchNotificationId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'dispatchNotificationId' + '}', CGI.escape(dispatch_notification_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"DispatchNotificationsApi.update_dispatch_notification",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchNotificationsApi#update_dispatch_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end