Class: PureCloud::LicenseApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/api/license_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LicenseApi

Returns a new instance of LicenseApi.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_license_definition(license_id, opts = {}) ⇒ LicenseDefinition

Get PureCloud license definition.

Parameters:

  • license_id —

    ID

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 32

def get_license_definition(license_id, opts = {})
  data, _status_code, _headers = get_license_definition_with_http_info(license_id, opts)
  return data
end

#get_license_definition_with_http_info(license_id, opts = {}) ⇒ Array<(LicenseDefinition, Fixnum, Hash)>

Get PureCloud license definition.

Parameters:

  • license_id —

    ID

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

    the optional parameters

Returns:

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

    LicenseDefinition data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 42

def get_license_definition_with_http_info(license_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_definition ..."
  end
  
  
  # verify the required parameter 'license_id' is set
  fail ArgumentError, "Missing the required parameter 'license_id' when calling LicenseApi.get_license_definition" if license_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/license/definitions/{licenseId}".sub('{format}','json').sub('{' + 'licenseId' + '}', license_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_definitions(opts = {}) ⇒ Array<LicenseDefinition>

Get all PureCloud license definitions available for the organization.

Parameters:

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 96

def get_license_definitions(opts = {})
  data, _status_code, _headers = get_license_definitions_with_http_info(opts)
  return data
end

#get_license_definitions_with_http_info(opts = {}) ⇒ Array<(Array<LicenseDefinition>, Fixnum, Hash)>

Get all PureCloud license definitions available for the organization.

Parameters:

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

    the optional parameters

Returns:

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

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



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

def get_license_definitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_definitions ..."
  end
  
  # resource path
  local_var_path = "/api/v2/license/definitions".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_organization(opts = {}) ⇒ LicenseOrganization

Get license assignments for the organization.

Parameters:

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 151

def get_license_organization(opts = {})
  data, _status_code, _headers = get_license_organization_with_http_info(opts)
  return data
end

#get_license_organization_with_http_info(opts = {}) ⇒ Array<(LicenseOrganization, Fixnum, Hash)>

Get license assignments for the organization.

Parameters:

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

    the optional parameters

Returns:

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

    LicenseOrganization data, response status code and response headers



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 160

def get_license_organization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_organization ..."
  end
  
  # resource path
  local_var_path = "/api/v2/license/organization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_toggle(feature_name, opts = {}) ⇒ LicenseOrgToggle

Get PureCloud license feature toggle value.

Parameters:

  • feature_name —

    featureName

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

    the optional parameters

Returns:



207
208
209
210
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 207

def get_license_toggle(feature_name, opts = {})
  data, _status_code, _headers = get_license_toggle_with_http_info(feature_name, opts)
  return data
end

#get_license_toggle_with_http_info(feature_name, opts = {}) ⇒ Array<(LicenseOrgToggle, Fixnum, Hash)>

Get PureCloud license feature toggle value.

Parameters:

  • feature_name —

    featureName

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

    the optional parameters

Returns:

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

    LicenseOrgToggle data, response status code and response headers



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 217

def get_license_toggle_with_http_info(feature_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_toggle ..."
  end
  
  
  # verify the required parameter 'feature_name' is set
  fail ArgumentError, "Missing the required parameter 'feature_name' when calling LicenseApi.get_license_toggle" if feature_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/license/toggles/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_license_user(user_id, opts = {}) ⇒ LicenseUser

Get licenses for specified user.

Parameters:

  • user_id —

    ID

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 272

def get_license_user(user_id, opts = {})
  data, _status_code, _headers = get_license_user_with_http_info(user_id, opts)
  return data
end

#get_license_user_with_http_info(user_id, opts = {}) ⇒ Array<(LicenseUser, Fixnum, Hash)>

Get licenses for specified user.

Parameters:

  • user_id —

    ID

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

    the optional parameters

Returns:

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

    LicenseUser data, response status code and response headers



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

def get_license_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.get_license_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling LicenseApi.get_license_user" if user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/license/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_license_organization(opts = {}) ⇒ Array<LicenseUpdateStatus>

Update the organization’s license assignments in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



337
338
339
340
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 337

def post_license_organization(opts = {})
  data, _status_code, _headers = post_license_organization_with_http_info(opts)
  return data
end

#post_license_organization_with_http_info(opts = {}) ⇒ Array<(Array<LicenseUpdateStatus>, Fixnum, Hash)>

Update the organization&#39;s license assignments in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 347

def post_license_organization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.post_license_organization ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/license/organization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_license_toggle(feature_name, opts = {}) ⇒ LicenseOrgToggle

Switch PureCloud license feature toggle value.

Parameters:

  • feature_name —

    featureName

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

    the optional parameters

Returns:



400
401
402
403
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 400

def post_license_toggle(feature_name, opts = {})
  data, _status_code, _headers = post_license_toggle_with_http_info(feature_name, opts)
  return data
end

#post_license_toggle_with_http_info(feature_name, opts = {}) ⇒ Array<(LicenseOrgToggle, Fixnum, Hash)>

Switch PureCloud license feature toggle value.

Parameters:

  • feature_name —

    featureName

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

    the optional parameters

Returns:

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

    LicenseOrgToggle data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 410

def post_license_toggle_with_http_info(feature_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.post_license_toggle ..."
  end
  
  
  # verify the required parameter 'feature_name' is set
  fail ArgumentError, "Missing the required parameter 'feature_name' when calling LicenseApi.post_license_toggle" if feature_name.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/license/toggles/{featureName}".sub('{format}','json').sub('{' + 'featureName' + '}', feature_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#post_license_users(opts = {}) ⇒ Hash<String, Object>

Fetch user licenses in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    The user IDs to fetch.

Returns:

  • (Hash<String, Object>) 


465
466
467
468
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 465

def post_license_users(opts = {})
  data, _status_code, _headers = post_license_users_with_http_info(opts)
  return data
end

#post_license_users_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Fixnum, Hash)>

Fetch user licenses in a batch.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    The user IDs to fetch.

Returns:

  • (Array<(Hash<String, Object>, Fixnum, Hash)>) —

    Hash<String, Object> data, response status code and response headers



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'lib/purecloudclient_v2a/api/license_api.rb', line 475

def post_license_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: LicenseApi.post_license_users ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/license/users".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Hash<String, Object>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LicenseApi#post_license_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end