Class: KoronaCloudClient::OrganizationalUnitsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationalUnitsApi

Returns a new instance of OrganizationalUnitsApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, day_rating, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new day ratings

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating (Array<DayRating>) —

    an array of new day ratings

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 28

def add_organizational_unit_day_ratings(, organizational_unit_id, day_rating, opts = {})
  data, _status_code, _headers = add_organizational_unit_day_ratings_with_http_info(, organizational_unit_id, day_rating, opts)
  data
end

#add_organizational_unit_day_ratings_with_http_info(korona_account_id, organizational_unit_id, day_rating, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

adds a batch of new day ratings

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating (Array<DayRating>) —

    an array of new day ratings

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

    the optional parameters

Returns:

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

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



39
40
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
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 39

def add_organizational_unit_day_ratings_with_http_info(, organizational_unit_id, day_rating, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.add_organizational_unit_day_ratings ...'
  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 OrganizationalUnitsApi.add_organizational_unit_day_ratings"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.add_organizational_unit_day_ratings"
  end
  # verify the required parameter 'day_rating' is set
  if @api_client.config.client_side_validation && day_rating.nil?
    fail ArgumentError, "Missing the required parameter 'day_rating' when calling OrganizationalUnitsApi.add_organizational_unit_day_ratings"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_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(day_rating)

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

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.add_organizational_unit_day_ratings",
    :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: OrganizationalUnitsApi#add_organizational_unit_day_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_organizational_units(korona_account_id, organizational_unit, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new organizational units

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit (Array<OrganizationalUnit>) —

    an array of new organizational units

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



107
108
109
110
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 107

def add_organizational_units(, organizational_unit, opts = {})
  data, _status_code, _headers = add_organizational_units_with_http_info(, organizational_unit, opts)
  data
end

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

adds a batch of new organizational units

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit (Array<OrganizationalUnit>) —

    an array of new organizational units

  • 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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
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
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 119

def add_organizational_units_with_http_info(, organizational_unit, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.add_organizational_units ...'
  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 OrganizationalUnitsApi.add_organizational_units"
  end
  # verify the required parameter 'organizational_unit' is set
  if @api_client.config.client_side_validation && organizational_unit.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit' when calling OrganizationalUnitsApi.add_organizational_units"
  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}/organizationalUnits'.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(organizational_unit)

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

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.add_organizational_units",
    :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: OrganizationalUnitsApi#add_organizational_units\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_organizational_unit(korona_account_id, organizational_unit_id, opts = {}) ⇒ nil

deletes the single organizational unit by its id

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

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

    the optional parameters

Returns:

  • (nil) 


187
188
189
190
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 187

def delete_organizational_unit(, organizational_unit_id, opts = {})
  delete_organizational_unit_with_http_info(, organizational_unit_id, opts)
  nil
end

#delete_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date, opts = {}) ⇒ nil

deletes the single day rating by its id or date

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating_id_or_date (String) —

    the id or date (YYYY-MM-DD) of the day rating

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

    the optional parameters

Returns:

  • (nil) 


255
256
257
258
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 255

def delete_organizational_unit_day_rating(, organizational_unit_id, day_rating_id_or_date, opts = {})
  delete_organizational_unit_day_rating_with_http_info(, organizational_unit_id, day_rating_id_or_date, opts)
  nil
end

#delete_organizational_unit_day_rating_with_http_info(korona_account_id, organizational_unit_id, day_rating_id_or_date, opts = {}) ⇒ Array<(nil, Integer, Hash)>

deletes the single day rating by its id or date

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating_id_or_date (String) —

    the id or date (YYYY-MM-DD) of the day rating

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 266

def delete_organizational_unit_day_rating_with_http_info(, organizational_unit_id, day_rating_id_or_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.delete_organizational_unit_day_rating ...'
  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 OrganizationalUnitsApi.delete_organizational_unit_day_rating"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.delete_organizational_unit_day_rating"
  end
  # verify the required parameter 'day_rating_id_or_date' is set
  if @api_client.config.client_side_validation && day_rating_id_or_date.nil?
    fail ArgumentError, "Missing the required parameter 'day_rating_id_or_date' when calling OrganizationalUnitsApi.delete_organizational_unit_day_rating"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings/{dayRatingIdOrDate}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_id.to_s)).sub('{' + 'dayRatingIdOrDate' + '}', CGI.escape(day_rating_id_or_date.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 => :"OrganizationalUnitsApi.delete_organizational_unit_day_rating",
    :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: OrganizationalUnitsApi#delete_organizational_unit_day_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

deletes the single organizational unit by its id

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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



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
244
245
246
247
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 197

def delete_organizational_unit_with_http_info(, organizational_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.delete_organizational_unit ...'
  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 OrganizationalUnitsApi.delete_organizational_unit"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.delete_organizational_unit"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_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 => :"OrganizationalUnitsApi.delete_organizational_unit",
    :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: OrganizationalUnitsApi#delete_organizational_unit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_organizational_units(korona_account_id, organizational_unit, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of organizational units

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit (Array<OrganizationalUnit>) —

    array of existing organizational units (id or number required)

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

    the optional parameters

Returns:



327
328
329
330
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 327

def delete_organizational_units(, organizational_unit, opts = {})
  data, _status_code, _headers = delete_organizational_units_with_http_info(, organizational_unit, opts)
  data
end

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

deletes a batch of organizational units

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit (Array<OrganizationalUnit>) —

    array of existing organizational units (id or number required)

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

    the optional parameters

Returns:

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

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



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
384
385
386
387
388
389
390
391
392
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 337

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

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

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.delete_organizational_units",
    :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: OrganizationalUnitsApi#delete_organizational_units\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit(korona_account_id, organizational_unit_id, opts = {}) ⇒ OrganizationalUnit

returns the single organizational unit

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

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

    the optional parameters

Returns:



399
400
401
402
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 399

def get_organizational_unit(, organizational_unit_id, opts = {})
  data, _status_code, _headers = get_organizational_unit_with_http_info(, organizational_unit_id, opts)
  data
end

#get_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date, opts = {}) ⇒ DayRating

returns the single day rating by its id or date

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating_id_or_date (String) —

    the id or date (YYYY-MM-DD) of the day rating

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

    the optional parameters

Returns:



467
468
469
470
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 467

def get_organizational_unit_day_rating(, organizational_unit_id, day_rating_id_or_date, opts = {})
  data, _status_code, _headers = get_organizational_unit_day_rating_with_http_info(, organizational_unit_id, day_rating_id_or_date, opts)
  data
end

#get_organizational_unit_day_rating_with_http_info(korona_account_id, organizational_unit_id, day_rating_id_or_date, opts = {}) ⇒ Array<(DayRating, Integer, Hash)>

returns the single day rating by its id or date

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating_id_or_date (String) —

    the id or date (YYYY-MM-DD) of the day rating

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

    the optional parameters

Returns:

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

    DayRating data, response status code and response headers



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
527
528
529
530
531
532
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 478

def get_organizational_unit_day_rating_with_http_info(, organizational_unit_id, day_rating_id_or_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.get_organizational_unit_day_rating ...'
  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 OrganizationalUnitsApi.get_organizational_unit_day_rating"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.get_organizational_unit_day_rating"
  end
  # verify the required parameter 'day_rating_id_or_date' is set
  if @api_client.config.client_side_validation && day_rating_id_or_date.nil?
    fail ArgumentError, "Missing the required parameter 'day_rating_id_or_date' when calling OrganizationalUnitsApi.get_organizational_unit_day_rating"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings/{dayRatingIdOrDate}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_id.to_s)).sub('{' + 'dayRatingIdOrDate' + '}', CGI.escape(day_rating_id_or_date.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] || 'DayRating'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit_day_rating",
    :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: OrganizationalUnitsApi#get_organizational_unit_day_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, opts = {}) ⇒ ResultListDayRating

lists all organizational unit related day ratings

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_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)

Returns:



542
543
544
545
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 542

def get_organizational_unit_day_ratings(, organizational_unit_id, opts = {})
  data, _status_code, _headers = get_organizational_unit_day_ratings_with_http_info(, organizational_unit_id, opts)
  data
end

#get_organizational_unit_day_ratings_with_http_info(korona_account_id, organizational_unit_id, opts = {}) ⇒ Array<(ResultListDayRating, Integer, Hash)>

lists all organizational unit related day ratings

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_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)

Returns:

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

    ResultListDayRating data, response status code and response headers



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/organizational_units_api.rb', line 555

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

  # 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] || 'ResultListDayRating'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit_day_ratings",
    :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: OrganizationalUnitsApi#get_organizational_unit_day_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit_inventory_lists(korona_account_id, organizational_unit_id, opts = {}) ⇒ ResultListInventoryList

lists the inventory lists belonging to the organizational unit (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

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

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

Returns:



625
626
627
628
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 625

def get_organizational_unit_inventory_lists(, organizational_unit_id, opts = {})
  data, _status_code, _headers = get_organizational_unit_inventory_lists_with_http_info(, organizational_unit_id, opts)
  data
end

#get_organizational_unit_inventory_lists_with_http_info(korona_account_id, organizational_unit_id, opts = {}) ⇒ Array<(ResultListInventoryList, Integer, Hash)>

lists the inventory lists belonging to the organizational unit (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

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

  • :booking_status (String) —

    booking status (possible values: BOOKED, IN_PROGRESS)

Returns:

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

    ResultListInventoryList data, response status code and response headers



645
646
647
648
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
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 645

def get_organizational_unit_inventory_lists_with_http_info(, organizational_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.get_organizational_unit_inventory_lists ...'
  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 OrganizationalUnitsApi.get_organizational_unit_inventory_lists"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.get_organizational_unit_inventory_lists"
  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}/organizationalUnits/{organizationalUnitId}/inventoryLists'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_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[:'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[:'bookingStatus'] = opts[:'booking_status'] if !opts[:'booking_status'].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] || 'ResultListInventoryList'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit_inventory_lists",
    :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: OrganizationalUnitsApi#get_organizational_unit_inventory_lists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit_product_stocks(korona_account_id, organizational_unit_id, opts = {}) ⇒ ResultListProductStock

lists the product stocks of the organizational unit (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :revision (Integer) —

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

  • :model_reference (Array<ModelReference>) —

    product data to filter

Returns:



718
719
720
721
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 718

def get_organizational_unit_product_stocks(, organizational_unit_id, opts = {})
  data, _status_code, _headers = get_organizational_unit_product_stocks_with_http_info(, organizational_unit_id, opts)
  data
end

#get_organizational_unit_product_stocks1(korona_account_id, organizational_unit_id, opts = {}) ⇒ ResultListProductStock

lists the product stocks of the organizational unit, in case it contains a warehouse (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

Returns:



797
798
799
800
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 797

def get_organizational_unit_product_stocks1(, organizational_unit_id, opts = {})
  data, _status_code, _headers = get_organizational_unit_product_stocks1_with_http_info(, organizational_unit_id, opts)
  data
end

#get_organizational_unit_product_stocks1_with_http_info(korona_account_id, organizational_unit_id, opts = {}) ⇒ Array<(ResultListProductStock, Integer, Hash)>

lists the product stocks of the organizational unit, in case it contains a warehouse (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

Returns:

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

    ResultListProductStock data, 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
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 811

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

  # 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] || 'ResultListProductStock'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit_product_stocks1",
    :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: OrganizationalUnitsApi#get_organizational_unit_product_stocks1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit_product_stocks_with_http_info(korona_account_id, organizational_unit_id, opts = {}) ⇒ Array<(ResultListProductStock, Integer, Hash)>

lists the product stocks of the organizational unit (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

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

    the optional parameters

Options Hash (opts):

  • :revision (Integer) —

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

  • :model_reference (Array<ModelReference>) —

    product data to filter

Returns:

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

    ResultListProductStock data, response status code and response headers



730
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
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 730

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'revision'] = opts[:'revision'] if !opts[:'revision'].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(opts[:'model_reference'])

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

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit_product_stocks",
    :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: OrganizationalUnitsApi#get_organizational_unit_product_stocks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit_stock_receipts(korona_account_id, organizational_unit_id, opts = {}) ⇒ ResultListStockReceipt

lists the stock receipts belonging to the organizational unit (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

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

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



884
885
886
887
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 884

def get_organizational_unit_stock_receipts(, organizational_unit_id, opts = {})
  data, _status_code, _headers = get_organizational_unit_stock_receipts_with_http_info(, organizational_unit_id, opts)
  data
end

#get_organizational_unit_stock_receipts_with_http_info(korona_account_id, organizational_unit_id, opts = {}) ⇒ Array<(ResultListStockReceipt, Integer, Hash)>

lists the stock receipts belonging to the organizational unit (KORONA Retail required)

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

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

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

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

    ResultListStockReceipt data, response status code and response headers



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

def get_organizational_unit_stock_receipts_with_http_info(, organizational_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.get_organizational_unit_stock_receipts ...'
  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 OrganizationalUnitsApi.get_organizational_unit_stock_receipts"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.get_organizational_unit_stock_receipts"
  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}/organizationalUnits/{organizationalUnitId}/stockReceipts'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_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[:'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[:'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] || 'ResultListStockReceipt'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit_stock_receipts",
    :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: OrganizationalUnitsApi#get_organizational_unit_stock_receipts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_unit_with_http_info(korona_account_id, organizational_unit_id, opts = {}) ⇒ Array<(OrganizationalUnit, Integer, Hash)>

returns the single organizational unit

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

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

    the optional parameters

Returns:

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

    OrganizationalUnit data, response status code and response headers



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
451
452
453
454
455
456
457
458
459
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 409

def get_organizational_unit_with_http_info(, organizational_unit_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.get_organizational_unit ...'
  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 OrganizationalUnitsApi.get_organizational_unit"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.get_organizational_unit"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_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] || 'OrganizationalUnit'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_unit",
    :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: OrganizationalUnitsApi#get_organizational_unit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organizational_units(korona_account_id, opts = {}) ⇒ ResultListOrganizationalUnit

lists all organizational units

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

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

  • :revision (Integer) —

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

  • :include_deleted (Boolean) —

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

  • :number (String) —

    number of the related object

Returns:



984
985
986
987
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 984

def get_organizational_units(, opts = {})
  data, _status_code, _headers = get_organizational_units_with_http_info(, opts)
  data
end

#get_organizational_units_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListOrganizationalUnit, Integer, Hash)>

lists all organizational units

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    number of the page to fetch

  • :size (Integer) —

    amount of objects to return per page

  • :sort (String) —

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

  • :revision (Integer) —

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

  • :include_deleted (Boolean) —

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

  • :number (String) —

    number of the related object

Returns:



999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 999

def get_organizational_units_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.get_organizational_units ...'
  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 OrganizationalUnitsApi.get_organizational_units"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits'.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[:'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] || 'ResultListOrganizationalUnit'

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.get_organizational_units",
    :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: OrganizationalUnitsApi#get_organizational_units\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_organizational_unit(korona_account_id, organizational_unit_id, organizational_unit, opts = {}) ⇒ nil

updates the organizational unit

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • organizational_unit (OrganizationalUnit) —

    the properties to update of the organizational unit

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

    the optional parameters

Returns:

  • (nil) 


1059
1060
1061
1062
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1059

def update_organizational_unit(, organizational_unit_id, organizational_unit, opts = {})
  update_organizational_unit_with_http_info(, organizational_unit_id, organizational_unit, opts)
  nil
end

#update_organizational_unit_day_rating(korona_account_id, organizational_unit_id, day_rating_id_or_date, day_rating, opts = {}) ⇒ nil

updates the day rating by its id or date

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating_id_or_date (String) —

    the id or date (YYYY-MM-DD) of the day rating

  • day_rating (DayRating) —

    the properties to update of the day rating

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

    the optional parameters

Returns:

  • (nil) 


1138
1139
1140
1141
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1138

def update_organizational_unit_day_rating(, organizational_unit_id, day_rating_id_or_date, day_rating, opts = {})
  update_organizational_unit_day_rating_with_http_info(, organizational_unit_id, day_rating_id_or_date, day_rating, opts)
  nil
end

#update_organizational_unit_day_rating_with_http_info(korona_account_id, organizational_unit_id, day_rating_id_or_date, day_rating, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the day rating by its id or date

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating_id_or_date (String) —

    the id or date (YYYY-MM-DD) of the day rating

  • day_rating (DayRating) —

    the properties to update of the day rating

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1150

def update_organizational_unit_day_rating_with_http_info(, organizational_unit_id, day_rating_id_or_date, day_rating, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.update_organizational_unit_day_rating ...'
  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 OrganizationalUnitsApi.update_organizational_unit_day_rating"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.update_organizational_unit_day_rating"
  end
  # verify the required parameter 'day_rating_id_or_date' is set
  if @api_client.config.client_side_validation && day_rating_id_or_date.nil?
    fail ArgumentError, "Missing the required parameter 'day_rating_id_or_date' when calling OrganizationalUnitsApi.update_organizational_unit_day_rating"
  end
  # verify the required parameter 'day_rating' is set
  if @api_client.config.client_side_validation && day_rating.nil?
    fail ArgumentError, "Missing the required parameter 'day_rating' when calling OrganizationalUnitsApi.update_organizational_unit_day_rating"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings/{dayRatingIdOrDate}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_id.to_s)).sub('{' + 'dayRatingIdOrDate' + '}', CGI.escape(day_rating_id_or_date.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(day_rating)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.update_organizational_unit_day_rating",
    :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: OrganizationalUnitsApi#update_organizational_unit_day_rating\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_organizational_unit_day_ratings(korona_account_id, organizational_unit_id, day_rating, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of day ratings

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating (Array<DayRating>) —

    an array of new day ratings

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

    the optional parameters

Returns:



1221
1222
1223
1224
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1221

def update_organizational_unit_day_ratings(, organizational_unit_id, day_rating, opts = {})
  data, _status_code, _headers = update_organizational_unit_day_ratings_with_http_info(, organizational_unit_id, day_rating, opts)
  data
end

#update_organizational_unit_day_ratings_with_http_info(korona_account_id, organizational_unit_id, day_rating, opts = {}) ⇒ Array<(Array<AddOrUpdateResult>, Integer, Hash)>

updates a batch of day ratings

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • day_rating (Array<DayRating>) —

    an array of new day ratings

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

    the optional parameters

Returns:

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

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



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1232

def update_organizational_unit_day_ratings_with_http_info(, organizational_unit_id, day_rating, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationalUnitsApi.update_organizational_unit_day_ratings ...'
  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 OrganizationalUnitsApi.update_organizational_unit_day_ratings"
  end
  # verify the required parameter 'organizational_unit_id' is set
  if @api_client.config.client_side_validation && organizational_unit_id.nil?
    fail ArgumentError, "Missing the required parameter 'organizational_unit_id' when calling OrganizationalUnitsApi.update_organizational_unit_day_ratings"
  end
  # verify the required parameter 'day_rating' is set
  if @api_client.config.client_side_validation && day_rating.nil?
    fail ArgumentError, "Missing the required parameter 'day_rating' when calling OrganizationalUnitsApi.update_organizational_unit_day_ratings"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/organizationalUnits/{organizationalUnitId}/dayRatings'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'organizationalUnitId' + '}', CGI.escape(organizational_unit_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(day_rating)

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

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.update_organizational_unit_day_ratings",
    :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: OrganizationalUnitsApi#update_organizational_unit_day_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_organizational_unit_with_http_info(korona_account_id, organizational_unit_id, organizational_unit, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the organizational unit

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit_id (String) —

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

  • organizational_unit (OrganizationalUnit) —

    the properties to update of the organizational unit

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1070

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

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.update_organizational_unit",
    :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: OrganizationalUnitsApi#update_organizational_unit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_organizational_units(korona_account_id, organizational_unit, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of organizational units; [number] must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit (Array<OrganizationalUnit>) —

    an array of existing organizational units

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

    the optional parameters

Returns:



1298
1299
1300
1301
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1298

def update_organizational_units(, organizational_unit, opts = {})
  data, _status_code, _headers = update_organizational_units_with_http_info(, organizational_unit, opts)
  data
end

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

updates a batch of organizational units; [number] must be set in the objects, otherwise the object cannot be updated

Parameters:

  • korona_account_id (String) —

    account id of the KORONA Studio account

  • organizational_unit (Array<OrganizationalUnit>) —

    an array of existing organizational units

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

    the optional parameters

Returns:

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

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



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
 
# File 'lib/korona-cloud-client/api/organizational_units_api.rb', line 1308

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

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

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

  new_options = opts.merge(
    :operation => :"OrganizationalUnitsApi.update_organizational_units",
    :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: OrganizationalUnitsApi#update_organizational_units\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end