Class: KoronaCloudClient::UserRolesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserRolesApi 



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

def api_client
  @api_client
end

Instance Method Details

#add_user_roles(korona_account_id, user_role, opts = {}) ⇒ Array<AddOrUpdateResult>

adds a batch of new user roles

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



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

def add_user_roles(, user_role, opts = {})
  data, _status_code, _headers = add_user_roles_with_http_info(, user_role, opts)
  data
end

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

adds a batch of new user roles

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 41

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

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

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

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

#delete_user_role(korona_account_id, user_role_id, opts = {}) ⇒ nil

deletes the single user role



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

def delete_user_role(, user_role_id, opts = {})
  delete_user_role_with_http_info(, user_role_id, opts)
  nil
end

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

deletes the single user role



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

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

#delete_user_roles(korona_account_id, user_role, opts = {}) ⇒ Array<AddOrUpdateResult>

deletes a batch of user roles



176
177
178
179
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 176

def delete_user_roles(, user_role, opts = {})
  data, _status_code, _headers = delete_user_roles_with_http_info(, user_role, opts)
  data
end

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

deletes a batch of user roles



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

def delete_user_roles_with_http_info(, user_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserRolesApi.delete_user_roles ...'
  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 UserRolesApi.delete_user_roles"
  end
  # verify the required parameter 'user_role' is set
  if @api_client.config.client_side_validation && user_role.nil?
    fail ArgumentError, "Missing the required parameter 'user_role' when calling UserRolesApi.delete_user_roles"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/userRoles'.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(user_role)

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

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

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

#get_user_role(korona_account_id, user_role_id, opts = {}) ⇒ UserRole

returns the single user role



248
249
250
251
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 248

def get_user_role(, user_role_id, opts = {})
  data, _status_code, _headers = get_user_role_with_http_info(, user_role_id, opts)
  data
end

#get_user_role_with_http_info(korona_account_id, user_role_id, opts = {}) ⇒ Array<(UserRole, Integer, Hash)>

returns the single user role



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 258

def get_user_role_with_http_info(, user_role_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserRolesApi.get_user_role ...'
  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 UserRolesApi.get_user_role"
  end
  # verify the required parameter 'user_role_id' is set
  if @api_client.config.client_side_validation && user_role_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_role_id' when calling UserRolesApi.get_user_role"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/userRoles/{userRoleId}'.sub('{' + 'koronaAccountId' + '}', CGI.escape(.to_s)).sub('{' + 'userRoleId' + '}', CGI.escape(user_role_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] || 'UserRole'

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

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

#get_user_roles(korona_account_id, opts = {}) ⇒ ResultListUserRole

lists all user roles

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



320
321
322
323
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 320

def get_user_roles(, opts = {})
  data, _status_code, _headers = get_user_roles_with_http_info(, opts)
  data
end

#get_user_roles_with_http_info(korona_account_id, opts = {}) ⇒ Array<(ResultListUserRole, Integer, Hash)>

lists all user roles

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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 335

def get_user_roles_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserRolesApi.get_user_roles ...'
  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 UserRolesApi.get_user_roles"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/userRoles'.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] || 'ResultListUserRole'

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

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

#update_user_role(korona_account_id, user_role_id, user_role, opts = {}) ⇒ nil

updates the single user role



395
396
397
398
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 395

def update_user_role(, user_role_id, user_role, opts = {})
  update_user_role_with_http_info(, user_role_id, user_role, opts)
  nil
end

#update_user_role_with_http_info(korona_account_id, user_role_id, user_role, opts = {}) ⇒ Array<(nil, Integer, Hash)>

updates the single user role



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 406

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_user_roles(korona_account_id, user_role, opts = {}) ⇒ Array<AddOrUpdateResult>

updates a batch of user roles



472
473
474
475
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 472

def update_user_roles(, user_role, opts = {})
  data, _status_code, _headers = update_user_roles_with_http_info(, user_role, opts)
  data
end

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

updates a batch of user roles



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
533
534
535
536
537
 
# File 'lib/korona-cloud-client/api/user_roles_api.rb', line 482

def update_user_roles_with_http_info(, user_role, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserRolesApi.update_user_roles ...'
  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 UserRolesApi.update_user_roles"
  end
  # verify the required parameter 'user_role' is set
  if @api_client.config.client_side_validation && user_role.nil?
    fail ArgumentError, "Missing the required parameter 'user_role' when calling UserRolesApi.update_user_roles"
  end
  # resource path
  local_var_path = '/accounts/{koronaAccountId}/userRoles'.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(user_role)

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

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

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