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, dispatch_notification_item, 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)

  • dispatch_notification_item (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; deprecated, use writeMode ADD_OR_UPDATE instead

  • :assign_existing_product (Boolean) —

    try to assign an existing product using codes set in import item data

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:



31
32
33
34
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 31

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

#add_dispatch_notification_items_with_http_info(korona_account_id, dispatch_notification_id, dispatch_notification_item, 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)

  • dispatch_notification_item (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; deprecated, use writeMode ADD_OR_UPDATE instead

  • :assign_existing_product (Boolean) —

    try to assign an existing product using codes set in import item data

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:

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

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



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
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 45

def add_dispatch_notification_items_with_http_info(, dispatch_notification_id, dispatch_notification_item, 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 'dispatch_notification_item' is set
  if @api_client.config.client_side_validation && dispatch_notification_item.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_item' when calling DispatchNotificationsApi.add_dispatch_notification_items"
  end
  allowable_values = ["DEFAULT", "ADD_OR_UPDATE", "ADD_OR_REPLACE"]
  if @api_client.config.client_side_validation && opts[:'write_mode'] && !allowable_values.include?(opts[:'write_mode'])
    fail ArgumentError, "invalid value for \"write_mode\", must be one of #{allowable_values}"
  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?
  query_params[:'assignExistingProduct'] = opts[:'assign_existing_product'] if !opts[:'assign_existing_product'].nil?
  query_params[:'writeMode'] = opts[:'write_mode'] if !opts[:'write_mode'].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(dispatch_notification_item)

  # 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, dispatch_notification, opts = {}) ⇒ Array<AddOrUpdateResult>

adds dispatch notifications

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification (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; deprecated, use writeMode ADD_OR_UPDATE instead

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:



120
121
122
123
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 120

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

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

adds dispatch notifications

Parameters:

  • korona_account_id (String) —

    account id of the KORONA.cloud account

  • dispatch_notification (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; deprecated, use writeMode ADD_OR_UPDATE instead

  • :write_mode (String) —

    DEFAULT &#x3D; insert; ADD_OR_UPDATE &#x3D; insert or update, overwrite all non-null fields; ADD_OR_REPLACE &#x3D; insert or update, overwrite all fields

Returns:

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

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



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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 132

def add_dispatch_notifications_with_http_info(, dispatch_notification, 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 'dispatch_notification' is set
  if @api_client.config.client_side_validation && dispatch_notification.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification' when calling DispatchNotificationsApi.add_dispatch_notifications"
  end
  allowable_values = ["DEFAULT", "ADD_OR_UPDATE", "ADD_OR_REPLACE"]
  if @api_client.config.client_side_validation && opts[:'write_mode'] && !allowable_values.include?(opts[:'write_mode'])
    fail ArgumentError, "invalid value for \"write_mode\", 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[:'upsert'] = opts[:'upsert'] if !opts[:'upsert'].nil?
  query_params[:'writeMode'] = opts[:'write_mode'] if !opts[:'write_mode'].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(dispatch_notification)

  # 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) 


200
201
202
203
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 200

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



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
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 210

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) 


267
268
269
270
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 267

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) 


335
336
337
338
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 335

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



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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 346

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



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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 277

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:



407
408
409
410
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 407

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:



476
477
478
479
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 476

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



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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 488

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:



555
556
557
558
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 555

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:



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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 570

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



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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 417

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:



644
645
646
647
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 644

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:



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
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 666

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, dispatch_notification, 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)

  • dispatch_notification (DispatchNotification) —

    data to update

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

    the optional parameters

Returns:

  • (nil) 


737
738
739
740
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 737

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

#update_dispatch_notification_item(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, dispatch_notification_item, 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)

  • dispatch_notification_item (DispatchNotificationItem) —

    data to update

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

    the optional parameters

Options Hash (opts):

  • :assign_existing_product (Boolean) —

    try to assign an existing product using codes set in import item data

Returns:

  • (nil) 


817
818
819
820
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 817

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

#update_dispatch_notification_item_with_http_info(korona_account_id, dispatch_notification_id, dispatch_notification_item_id, dispatch_notification_item, 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)

  • dispatch_notification_item (DispatchNotificationItem) —

    data to update

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

    the optional parameters

Options Hash (opts):

  • :assign_existing_product (Boolean) —

    try to assign an existing product using codes set in import item data

Returns:

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

    nil, response status code and response headers



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
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 830

def update_dispatch_notification_item_with_http_info(, dispatch_notification_id, dispatch_notification_item_id, dispatch_notification_item, 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 'dispatch_notification_item' is set
  if @api_client.config.client_side_validation && dispatch_notification_item.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_item' 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] || {}
  query_params[:'assignExistingProduct'] = opts[:'assign_existing_product'] if !opts[:'assign_existing_product'].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(dispatch_notification_item)

  # 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, dispatch_notification_item, 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)

  • dispatch_notification_item (Array<DispatchNotificationItem>) —

    data to update

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

    the optional parameters

Options Hash (opts):

  • :assign_existing_product (Boolean) —

    try to assign an existing product using codes set in import item data

Returns:



903
904
905
906
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 903

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

#update_dispatch_notification_items_with_http_info(korona_account_id, dispatch_notification_id, dispatch_notification_item, 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)

  • dispatch_notification_item (Array<DispatchNotificationItem>) —

    data to update

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

    the optional parameters

Options Hash (opts):

  • :assign_existing_product (Boolean) —

    try to assign an existing product using codes set in import item data

Returns:

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

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



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
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 915

def update_dispatch_notification_items_with_http_info(, dispatch_notification_id, dispatch_notification_item, 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 'dispatch_notification_item' is set
  if @api_client.config.client_side_validation && dispatch_notification_item.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification_item' 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] || {}
  query_params[:'assignExistingProduct'] = opts[:'assign_existing_product'] if !opts[:'assign_existing_product'].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(dispatch_notification_item)

  # 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, dispatch_notification, 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)

  • dispatch_notification (DispatchNotification) —

    data to update

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/korona-cloud-client/api/dispatch_notifications_api.rb', line 748

def update_dispatch_notification_with_http_info(, dispatch_notification_id, dispatch_notification, 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 'dispatch_notification' is set
  if @api_client.config.client_side_validation && dispatch_notification.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_notification' 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(dispatch_notification)

  # 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